bitags
Fast and flexible suite of operations for barcoded NGS reads.
Warning: This package is in early alpha. The API may change without notice and it is not yet recommended for production use.
About
Bitags is a package designed to simplify working with barcoded NGS reads. It relies on an adapted version of the bitap algorithm to perform fuzzy matching of tags composing a barcode (usually from a combinatorial barcoding method). Moreover, it provides additional utility functions for barcoded reads.
Currently supported features:
- Barcoding — identify and assign barcodes to reads using fuzzy bitap matching
- Trimming — trim reads based on a barcoding schema
- Classification — classify reads according to a barcoding schema
- Manipulation — embed barcodes, convert paired to unpaired reads
- I/O — read and write FASTQ files via lazy Polars DataFrames
- Visualization — visualize read structure in terminal, html or png.
Bitags can be used as a command line tool or through the Python API.
Installation
pip install bitags
Or from source by cloning and using maturin to build.
Usage
Proper documentation will be available soon, for now please rely on docstrings.
Cite
At the moment, there is no paper on Bitags. If you find this package useful for your work, please cite it by providing the link to the GitHub page.
License
BSD 3-Clause License. See LICENSE for details.
Metadata
Release files for bitags 0.1.7
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 |
|---|---|---|---|---|
| bitags-0.1.7.tar.gz | 38.2 kB | With provenance | Details for bitags-0.1.7.tar.gz |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| bitags-0.1.7-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | CPython 3.12 | abi3 | Linux glibc 2.17+ x86-64 | Details for bitags-0.1.7-cp312-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
| bitags-0.1.7-cp312-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl | CPython 3.12 | abi3 | Linux glibc 2.17+ ARM64 | Details for bitags-0.1.7-cp312-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl |
| bitags-0.1.7-cp312-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl | CPython 3.12 | abi3 | macOS 10.12+ x86-64, macOS 10.12+ universal2 (ARM64, x86-64), macOS 11.0+ ARM64 | Details for bitags-0.1.7-cp312-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl |
Total release size: 19.1 MB
Security for bitags 0.1.7
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 4 files in this release have been 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.