haplotype-plot

Generates haplotype plots from VCF files.


License
MIT
Install
pip install haplotype-plot==1.1.3

Documentation

Haplotype plot

Generates haplotype plots for VCF files. Requires Python 3 to run.

Build Status codecov

Pypi

You may install haplotype plot from pip:

pip install haplotype-plot

Usage

usage: main.py [-h] -v VCF [-o OUTPUT] -c CHR -p PARENTAL [--phase]
               [--version] [-z {HOM,HET}] [--conf KEY=VALUE [KEY=VALUE ...]]

Creates a haplotype plot from a VCF file

optional arguments:
  -h, --help            show this help message and exit
  -v VCF, --vcf VCF     path to the input sorted VCF file
  -o OUTPUT, --output OUTPUT
                        path to the output PNG haplotype plot file
  -c CHR, --chr CHR     chromosome to plot from the VCF
  -p PARENTAL, --parental PARENTAL
                        sample name from the VCF used as parental haplotype
  --phase               if specified, it will phase the genotypes. An output
                        VCF with the phased genotypes is created
  --version             show program's version number and exit
  -z {HOM,HET}, --zygosis {HOM,HET}
                        zygosis of the input VCF file
  --conf KEY=VALUE [KEY=VALUE ...]
                        set a number of key-value pairs to modify the default
                        plot configuration (do not put spaces before or after
                        the = sign). If a value contains spaces, you should
                        define it with double quotes: foo="this is a
                        sentence". Possible values are: 'start=integer',
                        'end=integer', 'show=boolean', 'xtickslabels=boolean',
                        'size_y=float'

For examples of use please go to the documentation.