Ambiguous-site counting for reads mapped back to their assembly
Project description
ssiamb
ssiamb counts ambiguous SNV sites from trimmed paired-end reads mapped back to
their own assembly.
The first supported workflow matches production use at SSI:
ssiamb self \
--r1 reads_R1.fastq.gz \
--r2 reads_R2.fastq.gz \
--assembly shovill_assembly.fasta \
--sample SAMPLE \
--outdir outputs
The tool assumes reads are already trimmed and the assembly has already been created, for example by Shovill.
Method
The default flow maps reads to the supplied assembly with minimap2, sorts the
alignment with samtools, calls variants with BBTools callvariants.sh, then
groups VCF records by (CHROM, POS) before counting ambiguous loci.
Default ambiguity criteria:
DP >= 10MAF >= 0.10- same-position ALT allele frequencies are summed before converting to MAF
- high ALT frequencies are converted with
MAF = min(AF, 1 - AF) - filtered caller records remain visible in diagnostics and are not hidden from the primary candidate set
Outputs
For sample SAMPLE, the CLI writes:
SAMPLE.summary.tsv: one-row summarySAMPLE.loci.tsv: grouped locus diagnosticsSAMPLE.matrix.tsv: cumulative depth/MAF matrixSAMPLE.variants.vcf: raw called variantsSAMPLE.provenance.json: command, thresholds, inputs, outputs, and tool info
External Tools
The end-to-end self workflow requires these commands on PATH:
minimap2samtoolscallvariants.shfrom BBTools/BBMap
Core VCF grouping and counting logic is pure Python and covered by unit tests.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ssiamb-1.0.0.tar.gz.
File metadata
- Download URL: ssiamb-1.0.0.tar.gz
- Upload date:
- Size: 10.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f053124ff9fb77aedee2918ef8b37759d630b056c95d2313318098d420285cd0
|
|
| MD5 |
16499168c2ccd539d4f8fe2533c92a74
|
|
| BLAKE2b-256 |
ab795cc1b906a410b5dae1192643fe8f290fd4b01ceee372207ab672c49773a4
|
Provenance
The following attestation bundles were made for ssiamb-1.0.0.tar.gz:
Publisher:
publish.yml on ssi-dk/ssiamb
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ssiamb-1.0.0.tar.gz -
Subject digest:
f053124ff9fb77aedee2918ef8b37759d630b056c95d2313318098d420285cd0 - Sigstore transparency entry: 1842292745
- Sigstore integration time:
-
Permalink:
ssi-dk/ssiamb@70c24f331eb4729f56324e3fda6238cf91c42d3f -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/ssi-dk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@70c24f331eb4729f56324e3fda6238cf91c42d3f -
Trigger Event:
push
-
Statement type:
File details
Details for the file ssiamb-1.0.0-py3-none-any.whl.
File metadata
- Download URL: ssiamb-1.0.0-py3-none-any.whl
- Upload date:
- Size: 11.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bbc43fc34d01710410b17b8546db7bc0b56a61723df1bf9198d7a1c942a546f9
|
|
| MD5 |
79fc96c89c6a1e60dcb03f89f5b75e9e
|
|
| BLAKE2b-256 |
abc7a8543dfb793abcd9c99027a770d1b00f7138a1544d8f710d5210e0401db0
|
Provenance
The following attestation bundles were made for ssiamb-1.0.0-py3-none-any.whl:
Publisher:
publish.yml on ssi-dk/ssiamb
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ssiamb-1.0.0-py3-none-any.whl -
Subject digest:
bbc43fc34d01710410b17b8546db7bc0b56a61723df1bf9198d7a1c942a546f9 - Sigstore transparency entry: 1842292911
- Sigstore integration time:
-
Permalink:
ssi-dk/ssiamb@70c24f331eb4729f56324e3fda6238cf91c42d3f -
Branch / Tag:
refs/tags/v1.0.0 - Owner: https://github.com/ssi-dk
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@70c24f331eb4729f56324e3fda6238cf91c42d3f -
Trigger Event:
push
-
Statement type: