Toolkit for benchmarking, merging, and annotating Structural Variants
📚 WIKI page has detailed documentation.
📈 See Updates on new versions.
📝 Read our Paper to learn more.
💻 Installation
Truvari uses Python 3.6+ and can be installed with pip:
python3 -m pip install Truvari
For details and more installation options, see Installation on the wiki.
⏩ Quick Start
Each sub-command contains help documentation. Start with truvari -h to see available commands.
The current most common Truvari use case is for structural variation benchmarking:
truvari bench -b base.vcf.gz -c comp.vcf.gz -o output_dir/
🧬 Truvari Commands
- bench - Performance metrics from comparison of two VCFs
- collapse - Collapse possibly redundant VCF entries
- anno - Add SV annotations to a VCF
- consistency - Consistency report between multiple VCFs
- vcf2df - Turn a VCF into a pandas DataFrame
- segment - Normalization of SVs into disjointed genomic regions
- stratify - Count variants per-region in vcf
- divide - Divide a VCF into independent shards
- phab - Harmonize variant representations using MSA
- refine - Automated bench result refinement with phab
🔎 More Information
All documentation about Truvari is on the WIKI. Additional information about using Truvari can be found in Discussions
Metadata
Release files for truvari 4.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| Truvari-4.1.0.tar.gz | 71.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| Truvari-4.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 162.4 kB
Release files / Truvari-4.1.0.tar.gz
| Download URL | Truvari-4.1.0.tar.gz |
|---|---|
| Size | 71.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c30ddee89d0a7107fb0638977cf52aa9751e2f666f109d57026204ca66310ea4
|
|
BLAKE2b-256 checksum How to use checksums |
745df907c056e82f9e37b9a20cc240ce86e8027e2213ba034f11a6fcf548f8c9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.17
|
Release files / Truvari-4.1.0-py3-none-any.whl
| Download URL | Truvari-4.1.0-py3-none-any.whl |
|---|---|
| Size | 91.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
244b12c3529ccce916aea735c9b180a335042c15ac9f761713399ea9d4ae7e7e
|
|
BLAKE2b-256 checksum How to use checksums |
9ed15a554f21f5731e1e528405f5f8b28d0b88e0a07805a1ee13da6d29e2d7f8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.17
|