Toolkit for benchmarking, merging, and annotating Structural Variants
📚 WIKI page has detailed user documentation.
🛠️ Developer Docs for the truvari API.
📈 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/
Find more matches by harmonizing phased varians using refine:
truvari refine -R -U -r reference.fa --regions output_dir/candidate.refine.bed output_dir/
Use Truvari's comparison engine to consolidate redundant variants in a merged multi-sample VCF:
bcftools merge -m none sampleA.vcf.gz sampleB.vcf.gz | bgzip > merge.vcf.gz
tabix merge.vcf.gz
truvari collapse -i merge.vcf.gz -o truvari_merge.vcf
🧬 Truvari Commands
- bench - Performance metrics from comparison of two VCFs
- collapse - Collapse possibly redundant VCF entries
- refine - Automated bench result refinement with phab
- anno - Add SV annotations to a VCF
- phab - Harmonize variant representations using MSA
- 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
- ga4gh - Consolidate benchmarking result VCFs
🔎 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 5.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-5.0.0.tar.gz | 89.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| truvari-5.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 197.8 kB
Release files / truvari-5.0.0.tar.gz
| Download URL | truvari-5.0.0.tar.gz |
|---|---|
| Size | 89.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5ef72fb27eff91086fed87417044d800823dbf446613a789268a9a042ef8bbf1
|
|
BLAKE2b-256 checksum How to use checksums |
dc2a22eac2f7b197cde779580ca80b29f98a1c2aeba139a1cf0bb8a8a97710ff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 10, 2025.
Transparency logRelease files / truvari-5.0.0-py3-none-any.whl
| Download URL | truvari-5.0.0-py3-none-any.whl |
|---|---|
| Size | 108.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
05a43d1d91e4da4760f19955a21632b319a4335e4f5ef315def90e9174723ece
|
|
BLAKE2b-256 checksum How to use checksums |
f8958dd7c9383401d94447311528723d7ac5c581926e8437fd87f6a28f019606
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 10, 2025.
Transparency log
