AlignCov
AlignCov is a bioinformatics tool which can be used to obtain a) alignment summary statistics and b) read depths from sorted BAM files in tidy tab-separated tables.
Future plans
- Create a Bioconda recipe
- Create a Docker image
Introduction
This script takes a sorted BAM file as input and uses SAMtools and Python Pandas to generate two tables:
_stats.tsv: A table of alignment summary statistics, including fold-coverages (fold_cov) and proportions of target lengths covered by mapped reads (prop_cov).- target: Name of the target.
- seqlen: Length of the target sequence (bp).
- depth: Total number of base pairs mapped to the target.
- len_cov: Total number of base pairs within the target that are covered by at least one mapped read.
- prop_cov: Proportion of the target length covered by at least one mapped read (len_cov / seqlen).
- fold_cov: Fold-coverage of mapped reads to the target (i.e. the number of times the target is completely covered by mapped reads) (depth / seqlen).
_depth.tsv: A table of read depths for each bp position of each target.- target: Name of the target.
- position: Base pair position within the target.
- depth: Total number of reads aligned to the base pair position within the target.
Dependencies
samtools>=1.15
Installation
AlignCov can be installed using Pip with the following command:
pip install aligncov
Usage
Quick start
For a sorted BAM file named 'bacillus.bam', compute alignment statistics and read depths, and save results to files named 'subtilis_stats.tsv' and 'subtilis_depth.tsv':
$ aligncov -i bacillus.bam -o subtilis
More options
To show the program's help message:
$ aligncov -h
usage: aligncov [-h] -i INPUT [-o OUTPUT]
Parse a sorted BAM file to generate two tables: a table of alignment summary statistics ('_stats.tsv'), including fold-coverages (fold_cov) and proportions of target lengths covered by mapped reads (prop_cov), and a table of read
depths ('_depth.tsv') for each bp position of each target.
options:
-h, --help show this help message and exit
Required:
-i INPUT, --input INPUT
Path to sorted BAM file to process.
Optional:
-o OUTPUT, --output OUTPUT
Path and base name of files to save as tab-separated tables ('[output]_stats.tsv', '[output]_depth.tsv'). Default: 'sample'
Credits
Packages
- Pandas: McKinney W. 2011. Pandas: A foundation python library for data analysis and statistics. Python for High Performance and Scientific Computing 1–9.
Dependencies
- SAMtools: Danecek P, Bonfield JK, Liddle J, Marshall J, Ohan V, Pollard MO, Whitwham A, Keane T, McCarthy SA, Davies RM, Li H. 2021. Twelve years of SAMtools and BCFtools. GigaScience 10(2) giab008. doi: 10.1093/gigascience/giab008
Project structure
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
======= History
0.0.2 (2023-08-13)
- Improved/fixed documentation on GitHub and PyPI.
0.0.1 (2023-08-12)
- First release on PyPI.
Metadata
Release files for aligncov 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| aligncov-0.0.2.tar.gz | 6.2 kB | Without provenance | Details for aligncov-0.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aligncov-0.0.2-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details for aligncov-0.0.2-py2.py3-none-any.whl |
Total release size: 12.9 kB
Release files / aligncov-0.0.2.tar.gz
| Download URL | aligncov-0.0.2.tar.gz |
|---|---|
| Size | 6.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
47ded440daebad7bdfa1e5e3a75925f3bf6e730e7de5b3f50060bf35e5ad0f43
|
|
BLAKE2b-256 checksum How to use checksums |
3673ef19f7f6999d59275301fac96f7f37eb8a20ecafc678a1d7ced25d6f26cd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Release files / aligncov-0.0.2-py2.py3-none-any.whl
| Download URL | aligncov-0.0.2-py2.py3-none-any.whl |
|---|---|
| Size | 6.7 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
d0f2460fe5d32bfce9d6bb3233759595221d924211cef4ebae4926cbd0317995
|
|
BLAKE2b-256 checksum How to use checksums |
b2abd19f3b17187c6b0cb1c30a7a3551c56e49a0d0ab69596177118cb8a2c03e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Security for aligncov 0.0.2
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.