Skip to main content

Parses SnpEff generated VCF and generates an HTML report.

Project description


Build Status Anaconda-Server Badge

A tool to generate an interactive HTML-based report from SnpEff annotated VCF file(s) with links to the Combat-TB-Explorer.





Using pip

$ pip install -i tbvcfreport

From source

$ git clone
$ cd tbvcfreport
$ virtualenv envname
$ source envname/bin/activate
$ pip install -r requirements.txt
$ pip install -e .

Run tbvcfreport

$ tbvcfreport --help
Usage: tbvcfreport [OPTIONS] COMMAND [ARGS]...

  Generate an HTML-based VCF report from SnpEff annotated VCF file(s).

  --help  Show this message and exit.

  generate  Generate an interactive HTML-based VCF report.
$ tbvcfreport generate --help
Usage: tbvcfreport generate [OPTIONS] VCF_DIR

  Generate an interactive HTML-based VCF report.

  -t, --tbprofiler-report FILENAME
                                  TBProfiler json report.
  -f, --filter-udi / -nf, --no-filter-udi
                                  Filter upstream, downstream and intergenic
                                  variants.  [default: True]
  --help                          Show this message and exit.
$ tbvcfreport generate VCF_DIR/

This will generate a {vcf-file-name}.html file in the current working directory (pwd).

In Galaxy


We have also added tbvcfreport to the Galaxy Test Tool Shed.

Kindly see this repository for the latest revision.


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

tbvcfreport-0.1.7.tar.gz (12.1 kB view hashes)

Uploaded source

Supported by

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