Skip to main content

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
+ 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


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.0.3.tar.gz (19.7 kB view details)

Uploaded Source

File details

Details for the file inheritance-0.0.3.tar.gz.

File metadata

  • Download URL: inheritance-0.0.3.tar.gz
  • Upload date:
  • Size: 19.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for inheritance-0.0.3.tar.gz
Algorithm Hash digest
SHA256 a43509a660d58b1f5eb80349ac5a950fe057f6f1d8d6a90bffb01c1e1a255d5f
MD5 1a67a96828238e503c9225ab1039877d
BLAKE2b-256 a6c10c9334535bcdbbd480647bb967779e76cf3a738b1b087f47bb5e2a7e31a1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page