===============
This package attempts to assign probability to a mendelian error event in a trio.
For example, given a mother with genotype 'C/C' and a father with genotype 'C/C'
a child with genotype 'C/T' will be a "mendelian error", in this case, a candidate
*de novo* mutation.
We can filter candidates based on their genotype likelihoods. For example if the
child had a genotype likelihood of -2,-1,-20 then we are likely to consider this
a genotyping error because the homozygous reference ("C/C" with GL -2) is fairly
close the the GL for het (with GL -1). If the genotype likelihood field was
-20,0,-20, then the call is confidently het. We can use the genotype likelihoods
to assign a probability:
```Python
>>> from mendelianerror import mendelian_error
# everyone is homref. this should have a low probability of an error:
>>> father = mother = child = [-0.1, -8.0, -8.0]
>>> mendelian_error(mother, father, child)
7.55...e-08
# parents are hom, child is het. this is a likely mendelian error:
>>> father = mother = [-0.6, -2.5, -2.5]
>>> child = [-2.5, -0.6, -2.5]
>>> mendelian_error(mother, father, child)
0.987...
```
So the input is the 3 GL numbers for each of the father, mother, child.
Installation
============
pip install mendelianerror
CLI
===
After installation, one can use this on a multi-sample VCF file like:
```Shell
mendelianerror $input.vcf father_id mother_id child_id > $new.vcf
```
to get only the putative mendelian errors, set a high cutoff:
```Shell
mendelianerror --cutoff 0.999 $input.vcf father_id mother_id child_id > $new.vcf
```
Limitations
===========
+ Only make sense for autosomal variants.
+ Only works on trios (doesn't consider extended pedigrees or siblings).
Metadata
Release files for mendelianerror 0.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mendelianerror-0.0.3.tar.gz | 4.5 kB | Without provenance | Details for mendelianerror-0.0.3.tar.gz |
Release files / mendelianerror-0.0.3.tar.gz
| Download URL | mendelianerror-0.0.3.tar.gz |
|---|---|
| Size | 4.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e524c38e23281fb010b7a785c888e9ce12775fbaa49f0d95e8b1e74558ed8d1f
|
|
BLAKE2b-256 checksum How to use checksums |
b60f29a160aabcd6aba8766ca6d88cd43976153004b710e56881618a808b1e13
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for mendelianerror 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.