Skip to main content

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.

Metadata

Release files for ssiamb 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ssiamb 1.0.0
File Size Uploaded Provenance Actions
ssiamb-1.0.0.tar.gz 10.7 kB With provenance Details for ssiamb-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ssiamb 1.0.0
File Interpreter ABI Platform Actions
ssiamb-1.0.0-py3-none-any.whl Python 3 none any Details for ssiamb-1.0.0-py3-none-any.whl

Total release size: 22.4 kB

Release files / ssiamb-1.0.0.tar.gz

Download URL ssiamb-1.0.0.tar.gz
Size 10.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f053124ff9fb77aedee2918ef8b37759d630b056c95d2313318098d420285cd0
BLAKE2b-256 checksum
How to use checksums
ab795cc1b906a410b5dae1192643fe8f290fd4b01ceee372207ab672c49773a4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 16, 2026.

Transparency log

Release files / ssiamb-1.0.0-py3-none-any.whl

Download URL ssiamb-1.0.0-py3-none-any.whl
Size 11.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bbc43fc34d01710410b17b8546db7bc0b56a61723df1bf9198d7a1c942a546f9
BLAKE2b-256 checksum
How to use checksums
abc7a8543dfb793abcd9c99027a770d1b00f7138a1544d8f710d5210e0401db0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 16, 2026.

Transparency log

Security for ssiamb 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for ssiamb-1.0.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Jun 16, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page