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.1
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.1.tar.gz | 79.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| truvari-4.2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 176.6 kB
Release files / truvari-4.2.1.tar.gz
| Download URL | truvari-4.2.1.tar.gz |
|---|---|
| Size | 79.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c6b797ad50db3e2b49d189241676ebcf66bfd57b8803bf43d3bc89f60bfe01d6
|
|
BLAKE2b-256 checksum How to use checksums |
c9b222739ffc691c2045ecbb8a6ec699cb0ae6d135634546466df64d7620a0e7
|
| 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.1-py3-none-any.whl
| Download URL | truvari-4.2.1-py3-none-any.whl |
|---|---|
| Size | 97.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
377d4f5328c4d133b35a26493930e384c93752ad7012e68e3a11a060cd981826
|
|
BLAKE2b-256 checksum How to use checksums |
59908df1b011debbb069db01b8afa190a7b72b8a90034b1c955e9c6bec39a3b0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
