Skip to main content

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 >= 10
  • MAF >= 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 summary
  • SAMPLE.loci.tsv: grouped locus diagnostics
  • SAMPLE.matrix.tsv: cumulative depth/MAF matrix
  • SAMPLE.variants.vcf: raw called variants
  • SAMPLE.provenance.json: command, thresholds, inputs, outputs, and tool info

External Tools

The end-to-end self workflow requires these commands on PATH:

  • minimap2
  • samtools
  • callvariants.sh from BBTools/BBMap

Core VCF grouping and counting logic is pure Python and covered by unit tests.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ssiamb-0.9.1.tar.gz (10.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ssiamb-0.9.1-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

Details for the file ssiamb-0.9.1.tar.gz.

File metadata

  • Download URL: ssiamb-0.9.1.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ssiamb-0.9.1.tar.gz
Algorithm Hash digest
SHA256 6520e8df6f81c749a5048290d1f90c0f010d63118a7c30590baf396c6b6a3141
MD5 c63df6f70a3692842afb62e4e398e6b8
BLAKE2b-256 79a0bb003d70274c201edc39e1c7aa8a40e924acc8f67a551d681519b74ecbf9

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssiamb-0.9.1.tar.gz:

Publisher: publish.yml on ssi-dk/ssiamb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ssiamb-0.9.1-py3-none-any.whl.

File metadata

  • Download URL: ssiamb-0.9.1-py3-none-any.whl
  • Upload date:
  • Size: 11.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ssiamb-0.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bc8974d5906adaecbe99e74164fcb3bc282da59273db9d21625da7d7fb7474ae
MD5 71effedf91eb52e81373527a67e58c22
BLAKE2b-256 1b6e758ab52677b4b4a28b48bec8faef309c892e669989a8b94f7e81042dfbf6

See more details on using hashes here.

Provenance

The following attestation bundles were made for ssiamb-0.9.1-py3-none-any.whl:

Publisher: publish.yml on ssi-dk/ssiamb

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page