Skip to main content
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`.

Metadata

Release files for inheritance 0.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for inheritance 0.0.3
File Size Uploaded Provenance Actions
inheritance-0.0.3.tar.gz 19.7 kB Without provenance Details for inheritance-0.0.3.tar.gz

Release files / inheritance-0.0.3.tar.gz

Download URL inheritance-0.0.3.tar.gz
Size 19.7 kB
Tags Source
SHA-256 checksum
How to use checksums
a43509a660d58b1f5eb80349ac5a950fe057f6f1d8d6a90bffb01c1e1a255d5f
BLAKE2b-256 checksum
How to use checksums
a6c10c9334535bcdbbd480647bb967779e76cf3a738b1b087f47bb5e2a7e31a1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for inheritance 0.0.3

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page