Skip to content
develop
Switch branches/tags
Go to file
Code

Latest commit

Also removing notes from collapse.py that have been placed on wiki
9ab1eef

Git stats

Files

Permalink
Failed to load latest commit information.

README.md

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

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 -f 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.

https://www.spiralgenetics.com