Trio¶
-
class
hail.genetics.
Trio
[source]¶ Class containing information about nuclear family relatedness and sex.
- Parameters
Attributes
Family ID.
Returns
True
if the proband is a reported female,False
if reported male, andNone
if no sex is defined.Returns
True
if the proband is a reported male,False
if reported female, andNone
if no sex is defined.ID of mother in trio, may be missing.
ID of father in trio, may be missing.
ID of proband in trio, never missing.
Methods
Returns True if the trio has a defined mother and father.
-
is_complete
()[source]¶ Returns True if the trio has a defined mother and father.
The considered fields are
mat_id()
andpat_id()
. Recall thats
may never be missing. Thefam_id()
andis_female()
fields may be missing in a complete trio.- Return type
-
property
is_female
¶ Returns
True
if the proband is a reported female,False
if reported male, andNone
if no sex is defined.
-
property
is_male
¶ Returns
True
if the proband is a reported male,False
if reported female, andNone
if no sex is defined.