inheritance models for mendelian genetics
Project description
inheritance models for mendelian diseases
-----------------------------------------
[![Build Status](https://travis-ci.org/brentp/inheritance.svg?branch=master)](https://travis-ci.org/brentp/inheritance)
This module is a general-purpose framework for evaluating if a family exihibits, for example, and autosomal dominant pattern.
The logic for this was tuned in [gemini](https://github.com/arq5x/gemini) but we make it available here as a more general purpose library to encourage:
1. community driven improvements
2. use outside of gemini
3. more comprehensive testing
Finding variants that match autosomal dominance in a trio, for example is very simple to find,
however, after considering multiple generations, arbitrary family sizes, depth cutoffs, and unknown
genotypes and phenotypes to support to real-world datasets it becomes tedious and error-prone.
Supported inheritance tests
===========================
+ autosomal dominant
+ autosomal recessive
+ de novo
+ X-linked dominant, recessive, and de novo
+ compound heterozygote
+ mendelian violation
Usage
=====
For now, the use is via api only. Users can look at the tests to see how to use. Most functions have a signature like:
```Python
auto_dom(self, min_depth=0, gt_ll=False, strict=True, only_affected=True)
```
where the arguments enforce a minimum depth, a maximum genotype likelihood, strictness (mostly related to parent-offspring requirements)
and wether to allow unaffecteds to have the variant (or be homozygous alt).
ToDo
====
1. add support for X-linked soon.
2. add a simple example of running on a VCF+PED
3. code coverage
4. code documentation
Testing
=======
Tests can be run as:
```
nosetests --with-coverage -x --with-doctest --cover-package inheritance
```
Overview
========
the generic code is in `inheritance/inheritance.py` and a specific implementation that we use in gemini is in `inheritance/pyeval.py`.
To make this available for a new resource, for example to `bcftools` we would look at the implementation of Filter in `inheritance/pyval.py`
and make the generated strings match those expected by `bcftools`.
-----------------------------------------
[![Build Status](https://travis-ci.org/brentp/inheritance.svg?branch=master)](https://travis-ci.org/brentp/inheritance)
This module is a general-purpose framework for evaluating if a family exihibits, for example, and autosomal dominant pattern.
The logic for this was tuned in [gemini](https://github.com/arq5x/gemini) but we make it available here as a more general purpose library to encourage:
1. community driven improvements
2. use outside of gemini
3. more comprehensive testing
Finding variants that match autosomal dominance in a trio, for example is very simple to find,
however, after considering multiple generations, arbitrary family sizes, depth cutoffs, and unknown
genotypes and phenotypes to support to real-world datasets it becomes tedious and error-prone.
Supported inheritance tests
===========================
+ autosomal dominant
+ autosomal recessive
+ de novo
+ X-linked dominant, recessive, and de novo
+ compound heterozygote
+ mendelian violation
Usage
=====
For now, the use is via api only. Users can look at the tests to see how to use. Most functions have a signature like:
```Python
auto_dom(self, min_depth=0, gt_ll=False, strict=True, only_affected=True)
```
where the arguments enforce a minimum depth, a maximum genotype likelihood, strictness (mostly related to parent-offspring requirements)
and wether to allow unaffecteds to have the variant (or be homozygous alt).
ToDo
====
1. add support for X-linked soon.
2. add a simple example of running on a VCF+PED
3. code coverage
4. code documentation
Testing
=======
Tests can be run as:
```
nosetests --with-coverage -x --with-doctest --cover-package inheritance
```
Overview
========
the generic code is in `inheritance/inheritance.py` and a specific implementation that we use in gemini is in `inheritance/pyeval.py`.
To make this available for a new resource, for example to `bcftools` we would look at the implementation of Filter in `inheritance/pyval.py`
and make the generated strings match those expected by `bcftools`.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
inheritance-0.1.5.tar.gz
(27.8 kB
view details)
File details
Details for the file inheritance-0.1.5.tar.gz
.
File metadata
- Download URL: inheritance-0.1.5.tar.gz
- Upload date:
- Size: 27.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.9.1 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.19.5 CPython/2.7.13
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 033371a643ed4987a6cf036a332723c9d6d6826cf89a7e97112083a4be231c04 |
|
MD5 | 2d6daaad628db2681e42b788dfa56f92 |
|
BLAKE2b-256 | a52fb006f0295e0dd03f9865ac13c955688318d11e0198511c5cb1ef5289327e |