Toolkit for benchmarking, merging, and annotating Structrual 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.0.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.0.0.tar.gz | 69.0 kB | Details |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| Truvari-4.0.0-py3.9.egg | Legacy Egg format | - | - | Details |
| Truvari-4.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 361.5 kB
Release files / Truvari-4.0.0.tar.gz
| Download URL | Truvari-4.0.0.tar.gz |
|---|---|
| Size | 69.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
11732baaf14f7027b6b0a82e3ef3e79387f8312d43a53e351cd7b9c0c91e62f6
|
|
BLAKE2b-256 checksum How to use checksums |
18c2eb61fda484af82ec5efeea1951ecab2b90abd0ffa59a6e2899a888ffd27e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / Truvari-4.0.0-py3.9.egg
| Download URL | Truvari-4.0.0-py3.9.egg |
|---|---|
| Size | 203.8 kB |
| Tags | Egg |
|
SHA-256 checksum How to use checksums |
4914f7fa390a683db4cb791483cb204e6cd7231ac9ad7e550db230b53a40ca9b
|
|
BLAKE2b-256 checksum How to use checksums |
0b4ae768316a3989025695f7536cb6cb2d8e0e739f89f2bcfbaf43ad4a51a087
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / Truvari-4.0.0-py3-none-any.whl
| Download URL | Truvari-4.0.0-py3-none-any.whl |
|---|---|
| Size | 88.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
126cdaf23006461bd8285775f7beca0d67580d46b825c00ccbd1060356c5d253
|
|
BLAKE2b-256 checksum How to use checksums |
9e2e7b3a3d330c8dac1df971bc1b281df3c3f3f8967c20c4542adc880d28147a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|