Skip to main content

Generates haplotype plots from VCF files.

Project description

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.


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

haplotype_plot-1.1.1.tar.gz (14.8 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