████████╗██████╗ ██╗ ██╗██╗ ██╗ █████╗ ██████╗ ██╗
╚══██╔══╝██╔══██╗██║ ██║██║ ██║██╔══██╗██╔══██╗██║
██║ ██████╔╝██║ ██║██║ ██║███████║██████╔╝██║
██║ ██╔══██╗██║ ██║╚██╗ ██╔╝██╔══██║██╔══██╗██║
██║ ██║ ██║╚██████╔╝ ╚████╔╝ ██║ ██║██║ ██║██║
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═══╝ ╚═╝ ╚═╝╚═╝ ╚═╝╚═╝
Structural variant toolkit for benchmarking, annotating and more for VCFs
WIKI page has detailed documentation. See Updates on new versions.
Installation
Truvari uses Python 3.7 and can be installed with pip:
pip install Truvari
PyPi has a history of all versions available. Pip installs all requirements EXCEPT external tools needed for running some annotations. See anno for details.
To build and install Truvari from scratch:
python -m pip install --upgrade pip setuptools wheel
python setup.py sdist bdist_wheel
pip install dist/Truvari-<version>.tar.gz
Where <version> is which version you just built.
See tags/ for a list of all available versions.
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 -r reference.fasta -o output_dir/
Truvari Commands
- bench - Performance metrics from comparison of two VCFs
- stats - Basic SV relevant VCF stats
- consistency - Consistency report between multiple VCFs
- anno - Annotate a VCF
More Information
Find more details and discussions about Truvari on the WIKI page.
1 maintainer
Metadata
1 maintainer
Release files for truvari 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-2.1.tar.gz | 42.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| Truvari-2.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 101.9 kB
Release files / Truvari-2.1.tar.gz
| Download URL | Truvari-2.1.tar.gz |
|---|---|
| Size | 42.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a67e89c84207900257bd1426646e935d18f1d568b5a91b6c80013c3cc1b55af9
|
|
BLAKE2b-256 checksum How to use checksums |
4ed87568d9e14252c4ea6f7c65b2b17ab792a42656340fe3888398e6aa8e1fce
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.6.9
|
Release files / Truvari-2.1-py3-none-any.whl
| Download URL | Truvari-2.1-py3-none-any.whl |
|---|---|
| Size | 59.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4ba3e8ef667c57416229ba771e78f6074722945262757c47e8b0b909d0350994
|
|
BLAKE2b-256 checksum How to use checksums |
424c6ecd3a4591719266438ede3aa4c1ae40dbf295a361718ecd66d69f0096fb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.6.9
|
