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
1 maintainer
Metadata
1 maintainer
Release files for truvari 4.2.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.2.0.tar.gz | 75.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| truvari-4.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 169.7 kB
Release files / truvari-4.2.0.tar.gz
| Download URL | truvari-4.2.0.tar.gz |
|---|---|
| Size | 75.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
10e7b7ab103247f56a8f7ede1802077a61c96073d1a7a502bb322029c57982e8
|
|
BLAKE2b-256 checksum How to use checksums |
d2cd4fdce5ccd1bf97e7f5e19dcd587c75d6dc4e45fcee0db3c77e2638e3363f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
Release files / truvari-4.2.0-py3-none-any.whl
| Download URL | truvari-4.2.0-py3-none-any.whl |
|---|---|
| Size | 93.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bf2c9032c832a0aeaf79e8ac093bf8db70c8349798c77dcad9bc5e90ab81b53a
|
|
BLAKE2b-256 checksum How to use checksums |
e514915e2fedc0ae3967af61b965d7884b9a27d9ba24bfc816f879011517ab24
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
