Skip to main content

Structural variant comparison tool for VCFs

Project description

████████╗██████╗ ██╗   ██╗██╗   ██╗ █████╗ ██████╗ ██╗
╚══██╔══╝██╔══██╗██║   ██║██║   ██║██╔══██╗██╔══██╗██║
   ██║   ██████╔╝██║   ██║██║   ██║███████║██████╔╝██║
   ██║   ██╔══██╗██║   ██║╚██╗ ██╔╝██╔══██║██╔══██╗██║
   ██║   ██║  ██║╚██████╔╝ ╚████╔╝ ██║  ██║██║  ██║██║
   ╚═╝   ╚═╝  ╚═╝ ╚═════╝   ╚═══╝  ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝

PyPI version pylint FuncTests coverage develop Downloads

Toolkit for benchmarking, merging, and annotating Structrual Variants

WIKI page has detailed documentation.
See Updates on new versions.
Read our Paper for more details.

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.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
  • divide - Divide a VCF into independent parts
  • segment - Normalization of SVs into disjointed genomic regions

More Information

Find more details and discussions about Truvari on the WIKI page.

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-3.5.0.tar.gz (59.9 kB view hashes)

Uploaded source

Built Distributions

Truvari-3.5.0-py3.9.egg (179.7 kB view hashes)

Uploaded 3 5 0

Truvari-3.5.0-py3-none-any.whl (78.7 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page