Skip to main content

Structural variant comparison tool for VCFs

Project description

PyPI version pylint FuncTests coverage develop Downloads

Logo
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 -f reference.fa -o output_dir/

Find more matches by harmonizing phased variants using refine:

   truvari refine 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

truvari-5.3.0.tar.gz (92.4 kB view details)

Uploaded Source

Built Distribution

truvari-5.3.0-py3-none-any.whl (112.1 kB view details)

Uploaded Python 3

File details

Details for the file truvari-5.3.0.tar.gz.

File metadata

  • Download URL: truvari-5.3.0.tar.gz
  • Upload date:
  • Size: 92.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for truvari-5.3.0.tar.gz
Algorithm Hash digest
SHA256 432f784e7fa55f6c3f82557082006949fcd629c906a5790d53c992f681fba36d
MD5 f72a1e36c3142db0323f8f56b3a62f2d
BLAKE2b-256 48d4fe2539cb929f2ce0c67fb0617d0253b3369b1b6ee2dab7fa5c7eacdb9f7f

See more details on using hashes here.

Provenance

The following attestation bundles were made for truvari-5.3.0.tar.gz:

Publisher: release.yml on ACEnglish/truvari

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file truvari-5.3.0-py3-none-any.whl.

File metadata

  • Download URL: truvari-5.3.0-py3-none-any.whl
  • Upload date:
  • Size: 112.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for truvari-5.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 768dd124149d97488d7a5f70360c954568daff0f0f49219171a6638ef1ed32e4
MD5 690f973e7e4099f9d47a36e1e5dd24e4
BLAKE2b-256 343abcc097543701ca77b6cb7cc20f0df7acdefd762ba272ad7ff4d6af6ba697

See more details on using hashes here.

Provenance

The following attestation bundles were made for truvari-5.3.0-py3-none-any.whl:

Publisher: release.yml on ACEnglish/truvari

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page