████████╗██████╗ ██╗ ██╗██╗ ██╗ █████╗ ██████╗ ██╗
╚══██╔══╝██╔══██╗██║ ██║██║ ██║██╔══██╗██╔══██╗██║
██║ ██████╔╝██║ ██║██║ ██║███████║██████╔╝██║
██║ ██╔══██╗██║ ██║╚██╗ ██╔╝██╔══██║██╔══██╗██║
██║ ██║ ██║╚██████╔╝ ╚████╔╝ ██║ ██║██║ ██║██║
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═══╝ ╚═╝ ╚═╝╚═╝ ╚═╝╚═╝
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.6+ and can be installed with pip:
python3 -m 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:
python3 setup.py install
See tags/ for a list of all available versions.
See Development/docker for instructions on how to build and use a Truvari Docker container.
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 -f reference.fasta -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
- vcf2df - Turn a VCF into a pandas DataFrame
- consistency - Consistency report between multiple VCFs
More Information
Find more details and discussions about Truvari on the WIKI page.
1 maintainer
Metadata
1 maintainer
Release files for truvari 3.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-3.0.0.tar.gz | 39.1 kB | Details |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| Truvari-3.0.0-py3.9.egg | Legacy Egg format | - | - | Details |
| Truvari-3.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 210.5 kB
Release files / Truvari-3.0.0.tar.gz
| Download URL | Truvari-3.0.0.tar.gz |
|---|---|
| Size | 39.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
911332a7e8a4d63422cb12d514330da1bcd331ae5b086f987e6f8e7513facdc4
|
|
BLAKE2b-256 checksum How to use checksums |
c0212ba205bb47dcfc6a560eaa0aa214986f3779c6198ed689b44af59c1c26cb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7
|
Release files / Truvari-3.0.0-py3.9.egg
| Download URL | Truvari-3.0.0-py3.9.egg |
|---|---|
| Size | 118.6 kB |
| Tags | Egg |
|
SHA-256 checksum How to use checksums |
d1e21979808f74735e43f9e4f2e9aafe4330dedeea9513434ba0dcaab93c8c07
|
|
BLAKE2b-256 checksum How to use checksums |
fc2ba9d8c96451815225e22d63d66a018aa2b935108b4ae5b2514ec23bdcc816
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7
|
Release files / Truvari-3.0.0-py3-none-any.whl
| Download URL | Truvari-3.0.0-py3-none-any.whl |
|---|---|
| Size | 52.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a3fbe25d7d988b523b5c1dacef49e7ca17134bc2dfc9716d7bfc69ef736578d9
|
|
BLAKE2b-256 checksum How to use checksums |
3c5a6e3655e04446dca565612a687a3b1ed5959d63d7109f9e7147333d1b9395
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7
|
