Skip to main content

Calling ROH in low coverage ancient DNA data (1240k SNPs) using modern reference panel

Project description

hapROH

Software to call ROHs in ancient and present-day DNA, using a haplotype reference panel. Author: Harald Ringbauer 2020

This package contains functions and wrappers to call ROH for ancient DNA data (for data on 1240k SNPs) and functions to visualize the results. It needs a haplotype reference panel.

For historical reasons and for compatibility, the package uses hapsburg as module name, after installation you can import functions via from hapsburg.XX import YY This will be updated in a follow-up release.

A vignette jupyter notebook walking through examples for how to use the core ROH calling function, and functions for plotting various aspects of ROH can be found at: https://www.dropbox.com/sh/eq4drs62tu6wuob/AABM41qAErmI2S3iypAV-j2da?dl=0

Installation

Youc can install the package using the Package manager pip:

python3 -m pip install hapROH

(python3 -m makes sure you use your python installation)

The package distributes source code. The setup.py contains information that should automatically build the necessary c extension. In case you want to manually build the c extension, find more info in the section below (c Extension)

Scope of the Method

Standard parameters are tuned for human 1240k capture data (1.2 million SNPs) and using 1000 Genome haplotypes as reference. The software worked for a wide range of test cases, both 1240k data and also whole genome sequencing data downsampled to 1240k. Test cases included 45k year old Ust Ishim man, and both American, Eurasian and Oceanian ancient DNA, showing that the method generally works for split times of reference panel and target up to a few 10k years (Neanderthals and Denisovans do not fall into that range).

In the first version, hapROH works on eigenstrat file (either packed or unpacked, the mode can be set). A future release will add functionality to use diploid genotype calls, or genotype likelihoods from a .vcf.

If you have whole genome data available, you should downsample to biallelic 1240k SNPs first.

In case you are planning applications to other kind of SNP or bigger SNP sets, or other organisms, the method parameters have to be updated. You can mirror our procedure (described in the publication), or contact me for assistance at:

harald_ringbauer AT hms harvard edu (fill in blanks with dots)

Get reference Data

Hapsburg currently uses global 1000 Genome haplotypes (n=5008), filtered down to bi-allelic 1240k SNPs, including a genetic map. We use .hdf5 format for the reference panel.

You can download the prepared reference data (including a necessary metadata .csv) from:
https://www.dropbox.com/s/0qhjgo1npeih0bw/1000g1240khdf5.tar.gz?dl=0

and unpack into a directory of your choise using

tar -xvf FILE.tar.gz

You then have to link the paths in the hapROH run parameters.

Example Use

Please find example notebooks, walking through a typical usecase, at https://www.dropbox.com/sh/eq4drs62tu6wuob/AABM41qAErmI2S3iypAV-j2da?dl=0

All you need is a packed or unpacked Eigenstrat file, and the reference data, and you are good to go to run your own application!

Dependencies

The basic requirements for calling ROH are minimal. There are extra Python packages that you need to install (e.g. via pip) if you want to use the plotting functionality, you should have matplotlib installed. For plotting of maps, you will need basemap (warning: installing can be tricky on some architectures). If you want to use the effective population size fitting functionality from ROH output, you will need to have statsmodels installed.

c Extension

The heavy lifting of the algorithm is coded into a cfunction cfunc.c, which is built via cython from cfunc.pyx

The package is distributed via source. This means the c extension has to be built. Ideally, this is done automatically via the package cython, as CYTHON=True in setup.py by default.

You can also set CYTHON=FALSE, then the extension is compiled from cfunc.c directly (not tested on all platforms)

Citation

If you use the software and want to cite it, you can use: https://www.biorxiv.org/content/10.1101/2020.05.31.126912v1

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for hapROH, version 0.1a2
Filename, size File type Python version Upload date Hashes
Filename, size hapROH-0.1a2.tar.gz (1.2 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page