Skip to main content

Altob

Abundance learning for ToBRFV variants. The primary purpose of the tool is:

  • Estimating abundace of clades of ToBRFV from sequencing data

You can read more about how Altob works in the Alcov preprint as it was originally developed for predicting abundances of variants of concern of SARS-CoV-2 in wastewater sequencing data, Alcov: Estimating Variant of Concern Abundance from SARS-CoV-2 Wastewater Sequencing Data

The tool can also be used for:

The tool is under active development. If you have questions or issues, please open an issue on GitHub or email me (email in setup.py).

Installing

The latest release can be downloaded from PyPI

pip install altob

This will install the Python library and the CLI.

To install the development version, clone the repository and run

pip install .

Usage example

Preprocessing

Altob expects a BAM file of reads aligned to the ToBRFV reference genome. For an example of how to process Illumina reads, check the prep directory for a script called "prep.py".

Estimating relative abundance of lineages/clades:

altob find_lineages reads.bam

Finding lineages in BAM files for multiple samples:

altob find_lineages samples.txt

Where samples.txt looks like:

path/to/reads1.bam	Sample 1 name
path/to/reads2.bam	Sample 2 name
...

Optionally specify which clades to look for

altob find_lineages reads.bam lineages.txt

Where lineages.txt looks like:

clade_1
clade_3
...

Optionally change minimum read depth (default 40)

altob find_lineages --min_depth=5 reads.bam

Optionally show how predicted mutation rates agree with observed mutation rates

altob find_lineages --show_stacked=True reads.bam

Use mutations which are found in multiple VOCs (can help for low coverage samples). Note: this is now the defaut behaviour.

altob find_lineages --unique=False reads.bam

Plotting changes in clade distributions over time for multiple sites

altob find_lineages --ts samples.txt

Where samples.txt looks like:

path/to/reads1.bam	SITE1_2021-09-10
path/to/reads2.bam	SITE1_2021-09-12
...
path/to/reads3.bam	SITE2_2021-09-10
path/to/reads4.bam	SITE2_2021-09-12
...

Converting mutation names:

(Note: These examples are from SARS-CoV-2 genomic sequences)

$ altob nt A23063T
A23063T causes S:N501Y
$ altob aa S:E484K
G23012A causes S:E484K

Finding mutations in BAM file:

altob find_mutants reads.bam

Finding mutations in BAM files for multiple samples:

altob find_mutants samples.txt

Where samples.txt looks like:

path/to/reads1.bam	Sample 1 name
path/to/reads2.bam	Sample 2 name
...

Running find_mutants will print the number of reads with and without each mutation in each sample and then generate a heatmap showing the frequencies for all samples.

You can also specify a custom mutations file:

altob find_mutants samples.txt mutations.txt

Where mutations.txt looks like: (Note: these examples are from SARS-CoV-2 genomic sequences)

S:N501Y
G23012A
...

Getting the read depth for each amplicon

altob amplicon_coverage reads.bam

or

altob amplicon_coverage samples.txt

Plotting amplicon GC content against amplicon depth

altob gc_depth reads.bam

or

altob gc_depth samples.txt

Metadata

Release files for altob 1.0.1

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

Source distribution (sdist)

Source distribution for altob 1.0.1
File Size Uploaded Provenance Actions
altob-1.0.1.tar.gz 20.9 kB Without provenance Details for altob-1.0.1.tar.gz

Built distribution (wheel)

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

Total release size: 43.2 kB

Release files / altob-1.0.1.tar.gz

Download URL altob-1.0.1.tar.gz
Size 20.9 kB
Tags Source
SHA-256 checksum
How to use checksums
3bb8750e63291703cb7abf600ab9f8706c662f14775c2ed339a46c16c427d737
BLAKE2b-256 checksum
How to use checksums
1ddb807304299aa6b1852689baf90de6c0371c9a34f0d130c2e0968994e6ba90
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.6

Release files / altob-1.0.1-py3-none-any.whl

Download URL altob-1.0.1-py3-none-any.whl
Size 22.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
81426b2e8abb1b1fe31b18c9b3a6a406dc2684430d334eb84708aa4b5ffb5e37
BLAKE2b-256 checksum
How to use checksums
9f2472a35ccdc6ccc9f3f8a4aa3ed4e59d88232d21aa4bc197daf81cd4c5ddfc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.6

Security for altob 1.0.1

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.

No provenance found

None of the files in this release were uploaded with provenance metadata.

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