VCF-kit: Assorted utilities for the variant call format
Branch: master
Clone or download
Latest commit eb45ec1 Oct 24, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Merge branch 'master' of https://github.com/Andersenlab/VCF-kit Oct 19, 2017
test_data add gatk vcf Feb 2, 2017
tests Fix phylo test Sep 12, 2017
vcfkit bump Oct 23, 2017
.coveragerc Remove un-runnable code from report Feb 1, 2017
.coveralls.yml Add repo token Nov 9, 2016
.gitignore update phylo tests; numbers slightly off Sep 12, 2017
.travis.yml revert to yahmm Oct 23, 2017
LICENSE Initial commit Jul 16, 2014
MANIFEST.in updates tests Feb 1, 2017
README.md vcf2tsv fix Apr 2, 2017
mkdocs.yml remove vcf2sql for now. Dec 4, 2016
requirements.txt Freeze networkx req Oct 23, 2017
setup.cfg fixes Oct 24, 2016
setup.py Add back install requires Oct 23, 2017

README.md

Build Status Coverage Status Documentation Status

VCF-kit - Documentation

VCF-kit is a command-line based collection of utilities for performing analysis on Variant Call Format (VCF) files. A summary of the commands is provided below.

Command Description
calc Obtain frequency/count of genotypes and alleles.
call Compare variants identified from sequences obtained through alternative methods against a VCF.
filter Filter variants with a minimum or maximum number of REF, HET, ALT, or missing calls.
geno Various operations at the genotype level.
genome Reference genome processing and management.
hmm Hidden-markov model for use in imputing genotypes from parental genotypes in linkage studies.
phylo Generate dendrograms from a VCF.
primer Generate primers for variant validation.
rename Add a prefix, suffix, or substitute a string in sample names.
tajima Calculate Tajima’s D.
vcf2tsv Convert a VCF to TSV.

Installation

You may need to install matplotlib. On linux this can be done with:

sudo apt-get build-dep python-matplotlib

On OSX it can be installed using:

pip install matplotlib  

You may need to install a few additional dependencies:

pip install yahmm
pip install numpy
pip install VCF-kit

Installing Dependencies:

In addition to python, VCF-kit requires that a number of additional programs be installed. We recommend using homebrew to manage dependencies. vk setup can be used to install these dependencies. Alternatively, you may use:

brew install bwa samtools bcftools blast muscle

vk setup requires homebrew (or if on linux, linux-brew) to install programs used by VCF-kit. The programs are listed below followed by the versions they have been tested with.

  • bwa (v 0.7.12)
  • samtools (v 1.3)
  • bcftools (v 1.3)
  • blast (v 2.2.31+)
  • muscle (v 3.8.31)