Toolkit for benchmarking, merging, and annotating Structural Variants
📚 WIKI page has detailed documentation.
📈 See Updates on new versions.
📝 Read our Papers (#1, #2) 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
1 maintainer
Metadata
1 maintainer
Release files for truvari 4.2.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 | |
|---|---|---|---|
| truvari-4.2.2.tar.gz | 80.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| truvari-4.2.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 178.8 kB
Release files / truvari-4.2.2.tar.gz
| Download URL | truvari-4.2.2.tar.gz |
|---|---|
| Size | 80.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4e7e504e8221b99c321d0825e32299954ef324f382b16fa09c97135aa1e4f872
|
|
BLAKE2b-256 checksum How to use checksums |
0cda1477cd47c464c481759a8ef137e00c3ad8ff5685613850c4b7f14e2f9fef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.9.19
|
Release files / truvari-4.2.2-py3-none-any.whl
| Download URL | truvari-4.2.2-py3-none-any.whl |
|---|---|
| Size | 98.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0a7c7a4a0b94ad5f85880dedb0acbf13d7e92efd8a557235a88ecea372e68440
|
|
BLAKE2b-256 checksum How to use checksums |
bf339f6157f00387d2033241360284f194a20ab6a72367adfcafde2599a4ece2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.9.19
|
