-
Notifications
You must be signed in to change notification settings - Fork 0
/
constants.py
1038 lines (943 loc) · 31.7 KB
/
constants.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
When you want to use free text for values, don't. Use preset constants instead.
All constants should be strings. The Extract stage converts all data to
strings, and we want to maintain the ability to compare with constants during
Transform.
"""
class COMMON:
CANNOT_COLLECT = "Not Allowed To Collect"
MULTIPLE = "Multiple"
NOT_APPLICABLE = "Not Applicable"
NOT_AVAILABLE = "Not Available"
NOT_REPORTED = "Not Reported"
NO_MATCH = "No Match"
NOT_ABLE_TO_PROVIDE = "Not Able to Provide"
OTHER = "Other"
UNKNOWN = "Reported Unknown"
TRUE = "True"
FALSE = "False"
class VISIBILITY_REASON:
READY = "Ready For Release"
PRE_RELEASE = "Pre-Release"
SAMPLE_ISSUE = "Sample Issue"
CONSENT_HOLD = "Consent Hold"
SEQUENCING_QUALITY = "Sequencing Quality Issue"
class AGE:
class UNITS:
DAYS = "Days"
MONTHS = "Months"
YEARS = "Years"
class FILE:
class HASH:
MD5 = "md5"
SHA1 = "sha1"
SHA256 = "sha256"
SHA512 = "sha512"
S3_ETAG = "etag"
class SPECIMEN:
class COMPOSITION:
BLOOD = "Peripheral Whole Blood"
BONE = "Bone"
BONE_MARROW = "Bone Marrow"
BUCCAL_SWAB = "Buccal Cells"
EBVI = "Epstein-Barr Virus Immortalized Cells"
FIBROBLASTS = "Fibroblasts"
LINE = "Derived Cell Line"
LYMPHOBLASTOID_CELL_LINES = "Lymphoblastoid Cell Lines"
LYMPHOCYTES = "Lymphocytes"
MNC = "Mononuclear Cells"
PLASMA = "Plasma"
SALIVA = "Saliva"
TISSUE = "Solid Tissue"
XENOGRAFT = "Xenograft Tissue"
class SAMPLE_PROCUREMENT:
AUTOPSY = "Autopsy"
BIOPSY = "Biopsy"
BLOOD_DRAW = "Blood Draw"
SALIVA_KIT = "Saliva Kit"
SUBTOTAL_RESECTION = "Subtotal Resection"
TOTAL_RESECTION = "Gross Total Resection"
BONE_MARROW_ASPIRATION = "Bone Marrow Aspiration"
class ANATOMY_SITE:
ARM = "Arm"
BONE_MARROW = "Bone Marrow"
HAIR = "Hair"
MOUTH = "Mouth"
SKULL = "Skull"
UMBILICAL_CORD = "Umbilical Cord"
CNS = "Central Nervous System"
class TISSUE_TYPE:
GERMLINE = "Normal"
NORMAL = "Normal"
TUMOR = "Tumor"
class GENOMIC_FILE:
class AVAILABILITY:
IMMEDIATE = "Immediate Download"
COLD_STORAGE = "Cold Storage"
class DATA_TYPE:
ALIGNED_READS = "Aligned Reads"
ALIGNED_READS_INDEX = "Aligned Reads Index"
EXPRESSION = "Expression"
GVCF = "gVCF"
GVCF_INDEX = "gVCF Index"
HISTOLOGY_IMAGES = "Histology Images"
NUCLEOTIDE_VARIATION = "Simple Nucleotide Variations"
OPERATION_REPORTS = "Operation Reports"
PATHOLOGY_REPORTS = "Pathology Reports"
RADIOLOGY_IMAGES = "Radiology Images"
RADIOLOGY_REPORTS = "Radiology Reports"
UNALIGNED_READS = "Unaligned Reads"
VARIANT_CALLS = "Variant Calls"
VARIANT_CALLS_INDEX = "Variant Calls Index"
ANNOTATED_SOMATIC_MUTATIONS = "Annotated Somatic Mutations"
GENE_EXPRESSION = "Gene Expression"
GENE_FUSIONS = "Gene Fusions"
ISOFORM_EXPRESSION = "Isoform Expression"
SOMATIC_COPY_NUMBER_VARIATIONS = "Somatic Copy Number Variations"
SOMATIC_STRUCTURAL_VARIATIONS = "Somatic Structural Variations"
class FORMAT:
BAI = "bai"
BAM = "bam"
CRAI = "crai"
CRAM = "cram"
DCM = "dcm"
FASTQ = "fastq"
GPR = "gpr"
GVCF = "gvcf"
IDAT = "idat"
PDF = "pdf"
SVS = "svs"
TBI = "tbi"
VCF = "vcf"
HTML = "html"
MAF = "maf"
class READ_GROUP:
class QUALITY_SCALE:
ILLUMINA13 = "Illumina13"
ILLUMINA15 = "Illumina15"
ILLUMINA18 = "Illumina18"
SANGER = "Sanger"
SOLEXA = "Solexa"
class SEQUENCING:
class REFERENCE_GENOME:
GRCH38 = "GRCh38"
GRCH37 = "GRCh37"
HS37D5 = "hs37d5"
HG19 = "hg19"
class PLATFORM:
GENOMICS = "Complete Genomics"
ILLUMINA = "Illumina"
ION_TORRENT = "Ion Torrent"
LS454 = "LS454"
PACBIO = "PacBio"
SOLID = "SOLiD"
ONT = "ONT"
class INSTRUMENT:
HISEQ_X_v2_5 = "HiSeq X v2.5"
HISEQ_X_10 = "HiSeq X Ten"
class STRAND:
FIRST = "First Stranded"
SECOND = "Second Stranded"
STRANDED = "Stranded"
UNSTRANDED = "Unstranded"
class CENTER:
class ASHION:
NAME = "Ashion"
KF_ID = "SC_0CNMF82N"
class BAYLOR:
NAME = "Baylor College of Medicine"
KF_ID = "SC_A1JNZAZH"
class BC_CANCER_AGENCY:
NAME = "British Columbia Cancer Agency Genome Sciences Centre"
KF_ID = "SC_FN7NH453"
class BGI:
NAME = "BGI@CHOP Genome Center"
KF_ID = "SC_WWEQ9HFY"
class BGI_CHINA:
NAME = "BGI"
KF_ID = "SC_FAD4KCQG"
class BROAD:
NAME = "Broad Institute"
KF_ID = "SC_DGDDQVYR"
class CBTN_UNSEQUENCED:
NAME = "CBTN Unsequenced"
KF_ID = "SC_31369RXZ"
class CHOP:
NAME = "CHOP"
KF_ID = "SC_9NSC532X"
class CHOP_DGD:
NAME = "CHOP DGD"
KF_ID = "SC_ZZPPF973"
class COMPLETE_GENOMICS:
NAME = "Complete Genomics"
KF_ID = "SC_D30SEWS4"
class CSIR:
NAME = "CSIR - Institute of Genomics and Integrative Biology, Delhi, India"
KF_ID = "SC_MDY0AZMZ"
class FELINE_DIAGNOSTICS:
NAME = "Feline Diagnostics LLC"
KF_ID = "SC_CATTVETT"
class FG:
NAME = "fg"
KF_ID = "SC_XXXXXXX2"
class GENEDX:
NAME = "GeneDx"
KF_ID = "SC_5EDC0A25"
class HGT:
NAME = "Humangenetik Tübingen"
KF_ID = "SC_75KENA7A"
class HUDSON_ALPHA:
NAME = "HudsonAlpha Institute for Biotechnology"
KF_ID = "SC_X1N69WJM"
class NANT:
NAME = "NantOmics"
KF_ID = "SC_N1EVHSME"
class NOVOGENE:
NAME = "Novogene"
KF_ID = "SC_2ZBAMKK0"
class NYGC:
NAME = "New York Genome Center"
KF_ID = "SC_BJW95TMY"
class NCI:
NAME = "National Cancer Institute, Khan Lab"
KF_ID = "SC_F6RZ51K9"
class NIH:
NAME = "National Institutes of Health"
KF_ID = "SC_HEXD2E5R"
class PRINCESS_MAXIMA:
NAME = "Princess Maxima Center"
KF_ID = "SC_V4CCQ3WE"
class SICKKIDS:
NAME = "SickKids"
KF_ID = "SC_9WMJKQ1X"
class SIDRA:
NAME = "Genomic Clinical Core at Sidra Medical and Research Center"
KF_ID = "SC_KE2ASNJM"
class ST_JUDE:
NAME = "St Jude"
KF_ID = "SC_1K3QGW4V"
class TEMP:
NAME = "TEMP"
KF_ID = "SC_SJJ0B9GN"
class TEMPUS:
NAME = "Tempus"
KF_ID = "SC_TQ8HJWGE"
class TGEN:
NAME = "The Translational Genomics Research Institute"
KF_ID = "SC_KQ9JZG3P"
class UNKNOWN_CHRIS_JONES:
NAME = "UNKNOWN:CHRIS_JONES"
KF_ID = "SC_5A2B1T4K"
class VIRTUAL:
NAME = "Virtual"
KF_ID = "SC_BATJDPHB"
class WASHU:
NAME = "Washington University"
KF_ID = "SC_K52V7463"
class YALE:
NAME = "Yale"
KF_ID = "SC_31W52VNX"
class FREDHUTCH:
NAME = "Fred Hutchinson Cancer Research Center"
KF_ID = "SC_8JXH42X1"
class STRATEGY:
LINKED_WGS = "Linked-Read WGS (10x Chromium)"
METHYL = "Methylation"
MRNA = "miRNA-Seq"
RNA = "RNA-Seq"
WGS = "WGS"
WXS = "WXS"
TARGETED = "Targeted Sequencing"
PANEL = "Panel"
SCRNA = "scRNA-Seq"
SNRNA = "snRNA-Seq"
CCS_WGS = "Circular Consensus Sequencing WGS"
CCS_RNA = "Circular Consensus Sequencing RNA-Seq"
CLR_WGS = "Continuous Long Reads WGS"
CLR_RNA = "Continuous Long Reads RNA-Seq"
ONT_WGS = "ONT WGS"
class ANALYTE:
DNA = "DNA"
RNA = "RNA"
VIRTUAL = "Virtual"
class LIBRARY:
class SELECTION:
HYBRID = "Hybrid Selection"
PCR = "PCR"
AFFINITY_ENRICHMENT = "Affinity Enrichment"
POLYT_ENRICHMENT = "Poly-T Enrichment"
RANDOM = "Random"
RNA_DEPLETION = "rRNA Depletion"
MRNA_SIZE_FRACTIONATION = "miRNA Size Fractionation"
class PREP:
POLYA = "polyA"
TOTALRNASEQ = "totalRNAseq"
class STUDY:
CANCER = "Cancer"
STRUCTURAL_DEFECT = "Structural Birth Defect"
STRUCTURAL_DEFECT_AND_CANCER = "Structural Birth Defect and Cancer"
class STATUS:
CANCELED = "Canceled"
FAILED = "Failed"
PENDING = "Pending"
PUBLISHED = "Published"
PUBLISHING = "Publishing"
RUNNING = "Running"
STAGED = "Staged"
WAITING = "Waiting"
class CONSENT_TYPE:
DS_OBDR_MDS = "DS-OBDR-MDS"
# Disease-Specific (Orofacial birth defects and related phenotypes,
# MDS) (DS-OBDR-MDS) - Use of the data must be related to Orofacial
# birth defects and related phenotypes. Use of the data includes
# methods development research (e.g., development of software or
# algorithms). Includes related diseases and phenotypes such as medical
# and dental data, speech characteristics, images and derived data
# (e.g. 3D facial measures, ultrasounds of the upper lip), and all
# other physical assessments taken on the study subjects.
DS_OBD_MDS = "DS-OBD-MDS"
# Disease-Specific (Orofacial birth defects, MDS) (DS-OBD-MDS) - Use of
# the data must be related to Orofacial birth defects. Use of the data
# includes methods development research (e.g., development of software
# or algorithms).
DS_OC_PUB_MDS = "DS-OC-PUB-MDS"
# Disease-Specific (Oral Clefts, PUB, MDS) (DS-OC-PUB-MDS) - Use of the
# data must be related to Oral Clefts. Requestor agrees to make results
# of studies using the data available to the larger scientific
# community. Use of the data includes methods development research
# (e.g., development of software or algorithms).
HMB_MDS = "HMB-MDS"
# Health/Medical/Biomedical (MDS) (HMB-MDS) - Use of this data is
# limited to health/medical/biomedical purposes, does not include the
# study of population origins or ancestry. Use of the data includes
# methods development research (e.g., development of software or
# algorithms).
HMB_IRB = "HMB-IRB"
# Health/Medical/Biomedical general research
DS_CHD_IRB = "DS-CHD-IRB"
# Disease specific Cardiac Heart Defect
DS_CHD = "DS-CHD"
# Disease specific Cardiac Heart Defect
HMB_NPU = "HMB-NPU"
# Health/Medical/Biomedical (NPU) (HMB-NPU) - Use of this data is
# limited to health/medical/biomedical purposes, does not include the
# study of population origins or ancestry. Use of the data is limited to
# not-for-profit organizations.
GRU = "GRU"
# General Research Use
GRU_NPU = "GRU-NPU"
# General Research Use (NPU) (GRU-NPU) - Use of this data is
# limited to general research use. Use of the data is limited to
# not-for-profit organizations.
HMB_GSO = "HMB-GSO"
# Health/Medical/Biomedical (GSO) (HMB-GSO) Genetic studies only.
# Use of the data is limited to genetic studies only
# (i.e., no “phenotype-only” research).
class AUTHORITY:
DBGAP = "dbGaP"
class OUTCOME:
class DISEASE_RELATED:
YES = "Yes"
NO = "No"
class VITAL_STATUS:
ALIVE = "Alive"
DEAD = "Deceased"
# ######################## NOTE ###############################################
# "Twin" relationships here mean identical twins.
# For non-identical twins please just use the normal sibling relationships.
# #############################################################################
class RELATIONSHIP:
PROBAND = "Proband"
# PARTNERS:
WIFE = "Wife"
HUSBAND = "Husband"
SPOUSE = "Spouse"
# PARENTS:
MOTHER = "Mother"
FATHER = "Father"
PARENT = "Parent"
# CHILDREN:
DAUGHTER = "Daughter"
SON = "Son"
CHILD = "Child"
# SIBLINGS:
SISTER = "Sister"
BROTHER = "Brother"
SIBLING = "Sibling"
TWIN_SISTER = "Twin Sister"
TWIN_BROTHER = "Twin Brother"
TWIN = "Twin"
MATERNAL_HALF_SISTER = "Maternal Half-Sister"
MATERNAL_HALF_BROTHER = "Maternal Half-Brother"
MATERNAL_HALF_SIBLING = "Maternal Half-Sibling"
PATERNAL_HALF_SISTER = "Paternal Half-Sister"
PATERNAL_HALF_BROTHER = "Paternal Half-Brother"
PATERNAL_HALF_SIBLING = "Paternal Half-Sibling"
HALF_SISTER = "Half-Sister"
HALF_BROTHER = "Half-Brother"
HALF_SIBLING = "Half-Sibling"
# GRANDPARENTS:
MATERNAL_GRANDMOTHER = "Maternal Grandmother"
MATERNAL_GRANDFATHER = "Maternal Grandfather"
MATERNAL_GRANDPARENT = "Maternal Grandparent"
PATERNAL_GRANDMOTHER = "Paternal Grandmother"
PATERNAL_GRANDFATHER = "Paternal Grandfather"
PATERNAL_GRANDPARENT = "Paternal Grandparent"
GRANDMOTHER = "Grandmother"
GRANDFATHER = "Grandfather"
GRANDPARENT = "Grandparent"
# GRANDCHILDREN:
MATERNAL_GRANDDAUGHTER = "Maternal Granddaughter"
MATERNAL_GRANDSON = "Maternal Grandson"
MATERNAL_GRANDCHILD = "Maternal Grandchild"
PATERNAL_GRANDDAUGHTER = "Paternal Granddaughter"
PATERNAL_GRANDSON = "Paternal Grandson"
PATERNAL_GRANDCHILD = "Paternal Grandchild"
GRANDDAUGHTER = "Granddaughter"
GRANDSON = "Grandson"
GRANDCHILD = "Grandchild"
# GREAT GRANDPARENTS:
MATERNAL_GREAT_GRANDMOTHER = "Maternal Great-Grandmother"
MATERNAL_GREAT_GRANDFATHER = "Maternal Great-Grandfather"
MATERNAL_GREAT_GRANDPARENT = "Maternal Great-Grandparent"
PATERNAL_GREAT_GRANDMOTHER = "Paternal Great-Grandmother"
PATERNAL_GREAT_GRANDFATHER = "Paternal Great-Grandfather"
PATERNAL_GREAT_GRANDPARENT = "Paternal Great-Grandparent"
GREAT_GRANDMOTHER = "Great-Grandmother"
GREAT_GRANDFATHER = "Great-Grandfather"
GREAT_GRANDPARENT = "Great-Grandparent"
# GREAT GRANDCHILDREN:
MATERNAL_GREAT_GRANDDAUGHTER = "Maternal Great-Granddaughter"
MATERNAL_GREAT_GRANDSON = "Maternal Great-Grandson"
MATERNAL_GREAT_GRANDCHILD = "Maternal Great-Grandchild"
PATERNAL_GREAT_GRANDDAUGHTER = "Paternal Great-Granddaughter"
PATERNAL_GREAT_GRANDSON = "Paternal Great-Grandson"
PATERNAL_GREAT_GRANDCHILD = "Paternal Great-Grandchild"
GREAT_GRANDDAUGHTER = "Great-Granddaughter"
GREAT_GRANDSON = "Great-Grandson"
GREAT_GRANDCHILD = "Great-Grandchild"
# AUNTS/UNCLES:
MATERNAL_AUNT = "Maternal Aunt"
MATERNAL_UNCLE = "Maternal Uncle"
MATERNAL_PIBLING = "Maternal Aunt or Uncle"
PATERNAL_AUNT = "Paternal Aunt"
PATERNAL_UNCLE = "Paternal Uncle"
PATERNAL_PIBLING = "Paternal Aunt or Uncle"
AUNT = "Aunt"
UNCLE = "Uncle"
PIBLING = "Aunt or Uncle"
# NIECES/NEPHEWS:
MATERNAL_NIECE = "Maternal Niece"
MATERNAL_NEPHEW = "Maternal Nephew"
MATERNAL_NIBLING = "Maternal Niece or Nephew"
PATERNAL_NIECE = "Paternal Niece"
PATERNAL_NEPHEW = "Paternal Nephew"
PATERNAL_NIBLING = "Paternal Niece or Nephew"
NIECE = "Niece"
NEPHEW = "Nephew"
NIBLING = "Niece or Nephew"
# GREAT AUNTS/UNCLES:
MATERNAL_GREAT_AUNT = "Maternal Great Aunt"
MATERNAL_GREAT_UNCLE = "Maternal Great Uncle"
MATERNAL_GREAT_PIBLING = "Maternal Great Aunt or Uncle"
PATERNAL_GREAT_AUNT = "Paternal Great Aunt"
PATERNAL_GREAT_UNCLE = "Paternal Great Uncle"
PATERNAL_GREAT_PIBLING = "Paternal Great Aunt or Uncle"
GREAT_AUNT = "Great Aunt"
GREAT_UNCLE = "Great Uncle"
GREAT_PIBLING = "Great Aunt or Uncle"
# GREAT NIECES/NEPHEWS:
MATERNAL_GREAT_NIECE = "Maternal Great Niece"
MATERNAL_GREAT_NEPHEW = "Maternal Great Nephew"
MATERNAL_GREAT_NIBLING = "Maternal Great Niece or Nephew"
PATERNAL_GREAT_NIECE = "Paternal Great Niece"
PATERNAL_GREAT_NEPHEW = "Paternal Great Nephew"
PATERNAL_GREAT_NIBLING = "Paternal Great Niece or Nephew"
GREAT_NIECE = "Great Niece"
GREAT_NEPHEW = "Great Nephew"
GREAT_NIBLING = "Great Niece or Nephew"
# COUSINS:
MATERNAL_FIRST_COUSIN = "Maternal First Cousin"
PATERNAL_FIRST_COUSIN = "Paternal First Cousin"
FIRST_COUSIN = "First Cousin"
MATERNAL_SECOND_COUSIN = "Maternal Second Cousin"
PATERNAL_SECOND_COUSIN = "Paternal Second Cousin"
SECOND_COUSIN = "Second Cousin"
MATERNAL_COUSIN = "Maternal Cousin"
PATERNAL_COUSIN = "Paternal Cousin"
COUSIN = "Cousin"
R = RELATIONSHIP
REVERSE_RELATIONSHIPS = {
# PARTNERS:
R.WIFE: R.SPOUSE,
R.HUSBAND: R.SPOUSE,
R.SPOUSE: R.SPOUSE,
# PARENTS:
R.MOTHER: R.CHILD,
R.FATHER: R.CHILD,
R.PARENT: R.CHILD,
# CHILDREN:
R.DAUGHTER: R.PARENT,
R.SON: R.PARENT,
R.CHILD: R.PARENT,
# SIBLINGS:
R.BROTHER: R.SIBLING,
R.SISTER: R.SIBLING,
R.SIBLING: R.SIBLING,
R.TWIN_BROTHER: R.TWIN,
R.TWIN_SISTER: R.TWIN,
R.TWIN: R.TWIN,
R.MATERNAL_HALF_SISTER: R.MATERNAL_HALF_SIBLING,
R.MATERNAL_HALF_BROTHER: R.MATERNAL_HALF_SIBLING,
R.MATERNAL_HALF_SIBLING: R.MATERNAL_HALF_SIBLING,
R.PATERNAL_HALF_SISTER: R.PATERNAL_HALF_SIBLING,
R.PATERNAL_HALF_BROTHER: R.PATERNAL_HALF_SIBLING,
R.PATERNAL_HALF_SIBLING: R.PATERNAL_HALF_SIBLING,
R.HALF_SISTER: R.HALF_SIBLING,
R.HALF_BROTHER: R.HALF_SIBLING,
R.HALF_SIBLING: R.HALF_SIBLING,
# GRANDPARENTS:
R.MATERNAL_GRANDMOTHER: R.MATERNAL_GRANDCHILD,
R.MATERNAL_GRANDFATHER: R.MATERNAL_GRANDCHILD,
R.MATERNAL_GRANDPARENT: R.MATERNAL_GRANDCHILD,
R.PATERNAL_GRANDMOTHER: R.PATERNAL_GRANDCHILD,
R.PATERNAL_GRANDFATHER: R.PATERNAL_GRANDCHILD,
R.PATERNAL_GRANDPARENT: R.PATERNAL_GRANDCHILD,
R.GRANDMOTHER: R.GRANDCHILD,
R.GRANDFATHER: R.GRANDCHILD,
R.GRANDPARENT: R.GRANDCHILD,
# GRANDCHILDREN:
R.MATERNAL_GRANDDAUGHTER: R.MATERNAL_GRANDPARENT,
R.MATERNAL_GRANDSON: R.MATERNAL_GRANDPARENT,
R.MATERNAL_GRANDCHILD: R.MATERNAL_GRANDPARENT,
R.PATERNAL_GRANDDAUGHTER: R.PATERNAL_GRANDPARENT,
R.PATERNAL_GRANDSON: R.PATERNAL_GRANDPARENT,
R.PATERNAL_GRANDCHILD: R.PATERNAL_GRANDPARENT,
R.GRANDDAUGHTER: R.GRANDPARENT,
R.GRANDSON: R.GRANDPARENT,
R.GRANDCHILD: R.GRANDPARENT,
# GREAT GRANDPARENTS:
R.MATERNAL_GREAT_GRANDMOTHER: R.MATERNAL_GREAT_GRANDCHILD,
R.MATERNAL_GREAT_GRANDFATHER: R.MATERNAL_GREAT_GRANDCHILD,
R.MATERNAL_GREAT_GRANDPARENT: R.MATERNAL_GREAT_GRANDCHILD,
R.PATERNAL_GREAT_GRANDMOTHER: R.PATERNAL_GREAT_GRANDCHILD,
R.PATERNAL_GREAT_GRANDFATHER: R.PATERNAL_GREAT_GRANDCHILD,
R.PATERNAL_GREAT_GRANDPARENT: R.PATERNAL_GREAT_GRANDCHILD,
R.GREAT_GRANDMOTHER: R.GREAT_GRANDCHILD,
R.GREAT_GRANDFATHER: R.GREAT_GRANDCHILD,
R.GREAT_GRANDPARENT: R.GREAT_GRANDCHILD,
# GREAT GRANDCHILDREN:
R.MATERNAL_GREAT_GRANDDAUGHTER: R.MATERNAL_GREAT_GRANDPARENT,
R.MATERNAL_GREAT_GRANDSON: R.MATERNAL_GREAT_GRANDPARENT,
R.MATERNAL_GREAT_GRANDCHILD: R.MATERNAL_GREAT_GRANDPARENT,
R.PATERNAL_GREAT_GRANDDAUGHTER: R.PATERNAL_GREAT_GRANDPARENT,
R.PATERNAL_GREAT_GRANDSON: R.PATERNAL_GREAT_GRANDPARENT,
R.PATERNAL_GREAT_GRANDCHILD: R.PATERNAL_GREAT_GRANDPARENT,
R.GREAT_GRANDDAUGHTER: R.GREAT_GRANDPARENT,
R.GREAT_GRANDSON: R.GREAT_GRANDPARENT,
R.GREAT_GRANDCHILD: R.GREAT_GRANDPARENT,
# AUNTS/UNCLES:
R.MATERNAL_AUNT: R.MATERNAL_NIBLING,
R.MATERNAL_UNCLE: R.MATERNAL_NIBLING,
R.MATERNAL_PIBLING: R.MATERNAL_NIBLING,
R.PATERNAL_AUNT: R.PATERNAL_NIBLING,
R.PATERNAL_UNCLE: R.PATERNAL_NIBLING,
R.PATERNAL_PIBLING: R.PATERNAL_NIBLING,
R.AUNT: R.NIBLING,
R.UNCLE: R.NIBLING,
R.PIBLING: R.NIBLING,
# NIECES/NEPHEWS:
R.MATERNAL_NIECE: R.MATERNAL_PIBLING,
R.MATERNAL_NEPHEW: R.MATERNAL_PIBLING,
R.MATERNAL_NIBLING: R.MATERNAL_PIBLING,
R.PATERNAL_NIECE: R.PATERNAL_PIBLING,
R.PATERNAL_NEPHEW: R.PATERNAL_PIBLING,
R.PATERNAL_NIBLING: R.PATERNAL_PIBLING,
R.NIECE: R.PIBLING,
R.NEPHEW: R.PIBLING,
R.NIBLING: R.PIBLING,
# GREAT AUNTS/UNCLES:
R.MATERNAL_GREAT_AUNT: R.MATERNAL_GREAT_NIBLING,
R.MATERNAL_GREAT_UNCLE: R.MATERNAL_GREAT_NIBLING,
R.MATERNAL_GREAT_PIBLING: R.MATERNAL_GREAT_NIBLING,
R.PATERNAL_GREAT_AUNT: R.PATERNAL_GREAT_NIBLING,
R.PATERNAL_GREAT_UNCLE: R.PATERNAL_GREAT_NIBLING,
R.PATERNAL_GREAT_PIBLING: R.PATERNAL_GREAT_NIBLING,
R.GREAT_AUNT: R.GREAT_NIBLING,
R.GREAT_UNCLE: R.GREAT_NIBLING,
R.GREAT_PIBLING: R.GREAT_NIBLING,
# GREAT NIECES/NEPHEWS:
R.MATERNAL_GREAT_NIECE: R.MATERNAL_GREAT_PIBLING,
R.MATERNAL_GREAT_NEPHEW: R.MATERNAL_GREAT_PIBLING,
R.MATERNAL_GREAT_NIBLING: R.MATERNAL_GREAT_PIBLING,
R.PATERNAL_GREAT_NIECE: R.PATERNAL_GREAT_PIBLING,
R.PATERNAL_GREAT_NEPHEW: R.PATERNAL_GREAT_PIBLING,
R.PATERNAL_GREAT_NIBLING: R.PATERNAL_GREAT_PIBLING,
R.GREAT_NIECE: R.GREAT_PIBLING,
R.GREAT_NEPHEW: R.GREAT_PIBLING,
R.GREAT_NIBLING: R.GREAT_PIBLING,
# COUSINS:
R.MATERNAL_FIRST_COUSIN: R.MATERNAL_FIRST_COUSIN,
R.PATERNAL_FIRST_COUSIN: R.PATERNAL_FIRST_COUSIN,
R.FIRST_COUSIN: R.FIRST_COUSIN,
R.MATERNAL_SECOND_COUSIN: R.MATERNAL_SECOND_COUSIN,
R.PATERNAL_SECOND_COUSIN: R.PATERNAL_SECOND_COUSIN,
R.SECOND_COUSIN: R.SECOND_COUSIN,
R.MATERNAL_COUSIN: R.MATERNAL_COUSIN,
R.PATERNAL_COUSIN: R.PATERNAL_COUSIN,
R.COUSIN: R.COUSIN,
}
class GENDER:
MALE = "Male"
FEMALE = "Female"
OTHER = "Other"
# relates gendered relationship terms to their genders.
GENDER_FROM_RELATION = {
r: g
for g, rs in {
GENDER.FEMALE: {
# PARTNERS (FEMALE):
R.WIFE,
# PARENTS (FEMALE):
R.MOTHER,
# CHILDREN (FEMALE):
R.DAUGHTER,
# SIBLINGS (FEMALE):
R.SISTER,
R.TWIN_SISTER,
R.MATERNAL_HALF_SISTER,
R.PATERNAL_HALF_SISTER,
R.HALF_SISTER,
# GRANDPARENTS (FEMALE):
R.MATERNAL_GRANDMOTHER,
R.PATERNAL_GRANDMOTHER,
R.GRANDMOTHER,
# GRANDCHILDREN (FEMALE):
R.MATERNAL_GRANDDAUGHTER,
R.PATERNAL_GRANDDAUGHTER,
R.GRANDDAUGHTER,
# GREAT GRANDPARENTS (FEMALE):
R.MATERNAL_GREAT_GRANDMOTHER,
R.PATERNAL_GREAT_GRANDMOTHER,
R.GREAT_GRANDMOTHER,
# GREAT GRANDCHILDREN (FEMALE):
R.MATERNAL_GREAT_GRANDDAUGHTER,
R.PATERNAL_GREAT_GRANDDAUGHTER,
R.GREAT_GRANDDAUGHTER,
# AUNTS/UNCLES (FEMALE):
R.MATERNAL_AUNT,
R.PATERNAL_AUNT,
R.AUNT,
# NIECES/NEPHEWS (FEMALE):
R.MATERNAL_NIECE,
R.PATERNAL_NIECE,
R.NIECE,
# GREAT AUNTS/UNCLES (FEMALE):
R.MATERNAL_GREAT_AUNT,
R.PATERNAL_GREAT_AUNT,
R.GREAT_AUNT,
# GREAT NIECES/NEPHEWS (FEMALE):
R.MATERNAL_GREAT_NIECE,
R.PATERNAL_GREAT_NIECE,
R.GREAT_NIECE,
# COUSINS (FEMALE): n/a
},
GENDER.MALE: {
# PARTNERS (MALE):
R.HUSBAND,
# PARENTS (MALE):
R.FATHER,
# CHILDREN (MALE):
R.SON,
# SIBLINGS (MALE):
R.BROTHER,
R.TWIN_BROTHER,
R.MATERNAL_HALF_BROTHER,
R.PATERNAL_HALF_BROTHER,
R.HALF_BROTHER,
# GRANDPARENTS (MALE):
R.MATERNAL_GRANDFATHER,
R.PATERNAL_GRANDFATHER,
R.GRANDFATHER,
# GRANDCHILDREN (MALE):
R.MATERNAL_GRANDSON,
R.PATERNAL_GRANDSON,
R.GRANDSON,
# GREAT GRANDPARENTS (MALE):
R.MATERNAL_GREAT_GRANDFATHER,
R.PATERNAL_GREAT_GRANDFATHER,
R.GREAT_GRANDFATHER,
# GREAT GRANDCHILDREN (MALE):
R.MATERNAL_GREAT_GRANDSON,
R.PATERNAL_GREAT_GRANDSON,
R.GREAT_GRANDSON,
# AUNTS/UNCLES (MALE):
R.MATERNAL_UNCLE,
R.PATERNAL_UNCLE,
R.UNCLE,
# NIECES/NEPHEWS (MALE):
R.MATERNAL_NEPHEW,
R.PATERNAL_NEPHEW,
R.NEPHEW,
# GREAT AUNTS/UNCLES (MALE):
R.MATERNAL_GREAT_UNCLE,
R.PATERNAL_GREAT_UNCLE,
R.GREAT_UNCLE,
# GREAT NIECES/NEPHEWS (MALE):
R.MATERNAL_GREAT_NEPHEW,
R.PATERNAL_GREAT_NEPHEW,
R.GREAT_NEPHEW,
# COUSINS (MALE): n/a
},
}.items()
for r in rs
}
# relates generic relationship terms to gendered ones
GENDERED_RELATIONSHIPS = {
# PARTNERS:
R.SPOUSE: {
GENDER.MALE: R.HUSBAND,
GENDER.FEMALE: R.WIFE,
},
# PARENTS:
R.PARENT: {
GENDER.MALE: R.FATHER,
GENDER.FEMALE: R.MOTHER,
},
# CHILDREN:
R.CHILD: {
GENDER.MALE: R.SON,
GENDER.FEMALE: R.DAUGHTER,
},
# SIBLINGS:
R.SIBLING: {
GENDER.MALE: R.BROTHER,
GENDER.FEMALE: R.SISTER,
},
R.TWIN: {
GENDER.MALE: R.TWIN_BROTHER,
GENDER.FEMALE: R.TWIN_SISTER,
},
R.MATERNAL_HALF_SIBLING: {
GENDER.MALE: R.MATERNAL_HALF_BROTHER,
GENDER.FEMALE: R.MATERNAL_HALF_SISTER,
},
R.PATERNAL_HALF_SIBLING: {
GENDER.MALE: R.PATERNAL_HALF_BROTHER,
GENDER.FEMALE: R.PATERNAL_HALF_SISTER,
},
R.HALF_SIBLING: {
GENDER.MALE: R.HALF_BROTHER,
GENDER.FEMALE: R.HALF_SISTER,
},
# GRANDPARENTS:
R.MATERNAL_GRANDPARENT: {
GENDER.MALE: R.MATERNAL_GRANDFATHER,
GENDER.FEMALE: R.MATERNAL_GRANDMOTHER,
},
R.PATERNAL_GRANDPARENT: {
GENDER.MALE: R.PATERNAL_GRANDFATHER,
GENDER.FEMALE: R.PATERNAL_GRANDMOTHER,
},
R.GRANDPARENT: {
GENDER.MALE: R.GRANDFATHER,
GENDER.FEMALE: R.GRANDMOTHER,
},
# GRANDCHILDREN:
R.MATERNAL_GRANDCHILD: {
GENDER.MALE: R.MATERNAL_GRANDSON,
GENDER.FEMALE: R.MATERNAL_GRANDDAUGHTER,
},
R.PATERNAL_GRANDCHILD: {
GENDER.MALE: R.PATERNAL_GRANDSON,
GENDER.FEMALE: R.PATERNAL_GRANDDAUGHTER,
},
R.GRANDCHILD: {
GENDER.MALE: R.GRANDSON,
GENDER.FEMALE: R.GRANDDAUGHTER,
},
# GREAT GRANDPARENTS:
R.MATERNAL_GREAT_GRANDPARENT: {
GENDER.MALE: R.MATERNAL_GREAT_GRANDFATHER,
GENDER.FEMALE: R.MATERNAL_GREAT_GRANDMOTHER,
},
R.PATERNAL_GREAT_GRANDPARENT: {
GENDER.MALE: R.PATERNAL_GREAT_GRANDFATHER,
GENDER.FEMALE: R.PATERNAL_GREAT_GRANDMOTHER,
},
R.GREAT_GRANDPARENT: {
GENDER.MALE: R.GREAT_GRANDFATHER,
GENDER.FEMALE: R.GREAT_GRANDMOTHER,
},
# GREAT GRANDCHILDREN:
R.MATERNAL_GREAT_GRANDCHILD: {
GENDER.MALE: R.MATERNAL_GREAT_GRANDSON,
GENDER.FEMALE: R.MATERNAL_GREAT_GRANDDAUGHTER,
},
R.PATERNAL_GREAT_GRANDCHILD: {
GENDER.MALE: R.PATERNAL_GREAT_GRANDSON,
GENDER.FEMALE: R.PATERNAL_GREAT_GRANDDAUGHTER,
},
R.GREAT_GRANDCHILD: {
GENDER.MALE: R.GREAT_GRANDSON,
GENDER.FEMALE: R.GREAT_GRANDDAUGHTER,
},
# AUNTS/UNCLES:
R.MATERNAL_PIBLING: {
GENDER.MALE: R.MATERNAL_UNCLE,
GENDER.FEMALE: R.MATERNAL_AUNT,
},
R.PATERNAL_PIBLING: {
GENDER.MALE: R.PATERNAL_UNCLE,
GENDER.FEMALE: R.PATERNAL_AUNT,
},
R.PIBLING: {
GENDER.MALE: R.UNCLE,
GENDER.FEMALE: R.AUNT,
},
# NIECES/NEPHEWS:
R.MATERNAL_NIBLING: {
GENDER.MALE: R.MATERNAL_NEPHEW,
GENDER.FEMALE: R.MATERNAL_NIECE,
},
R.PATERNAL_NIBLING: {
GENDER.MALE: R.PATERNAL_NEPHEW,
GENDER.FEMALE: R.PATERNAL_NIECE,
},
R.NIBLING: {
GENDER.MALE: R.NEPHEW,
GENDER.FEMALE: R.NIECE,
},
# GREAT AUNTS/UNCLES:
R.MATERNAL_GREAT_PIBLING: {
GENDER.MALE: R.MATERNAL_GREAT_UNCLE,
GENDER.FEMALE: R.MATERNAL_GREAT_AUNT,
},
R.PATERNAL_GREAT_PIBLING: {
GENDER.MALE: R.PATERNAL_GREAT_UNCLE,
GENDER.FEMALE: R.PATERNAL_GREAT_AUNT,
},
R.GREAT_PIBLING: {
GENDER.MALE: R.GREAT_UNCLE,
GENDER.FEMALE: R.GREAT_AUNT,
},
# GREAT NIECES/NEPHEWS:
R.MATERNAL_GREAT_NIBLING: {
GENDER.MALE: R.MATERNAL_GREAT_NEPHEW,
GENDER.FEMALE: R.MATERNAL_GREAT_NIECE,
},
R.PATERNAL_GREAT_NIBLING: {
GENDER.MALE: R.PATERNAL_GREAT_NEPHEW,
GENDER.FEMALE: R.PATERNAL_GREAT_NIECE,
},
R.GREAT_NIBLING: {
GENDER.MALE: R.GREAT_NEPHEW,
GENDER.FEMALE: R.GREAT_NIECE,
},
# COUSINS: n/a
}
# Relates sibling groups to their known parents.
# Don't include proband in siblings or parents.
RELATIONSHIP_PARENTS = [
# SIBLINGS & PARENTS:
{
"siblings": {
R.BROTHER,
R.SISTER,
R.SIBLING,
R.TWIN_BROTHER,
R.TWIN_SISTER,
R.TWIN,
R.MATERNAL_HALF_BROTHER,
R.MATERNAL_HALF_SISTER,
R.MATERNAL_HALF_SIBLING,
R.PATERNAL_HALF_BROTHER,
R.PATERNAL_HALF_SISTER,
R.PATERNAL_HALF_SIBLING,
R.HALF_BROTHER,
R.HALF_SISTER,
R.HALF_SIBLING,
},
"mother": R.MOTHER,
"father": R.FATHER,
"generic": R.PARENT,
},
# MATERNAL GRANDPARENTS:
{
"siblings": {R.MOTHER},
"mother": R.MATERNAL_GRANDMOTHER,
"father": R.MATERNAL_GRANDFATHER,
"generic": R.MATERNAL_GRANDPARENT,
},
# PATERNAL GRANDPARENTS:
{
"siblings": {R.FATHER},
"mother": R.PATERNAL_GRANDMOTHER,
"father": R.PATERNAL_GRANDFATHER,
"generic": R.PATERNAL_GRANDPARENT,
},
# GREAT GRANDPARENTS:
{
"siblings": {R.GRANDMOTHER},
"mother": R.GREAT_GRANDMOTHER,
"father": R.GREAT_GRANDFATHER,
"generic": R.GREAT_GRANDPARENT,
},
{
"siblings": {R.GRANDFATHER},
"mother": R.GREAT_GRANDMOTHER,
"father": R.GREAT_GRANDFATHER,
"generic": R.GREAT_GRANDPARENT,
},
# MATERNAL GREAT GRANDPARENTS:
{
"siblings": {R.MATERNAL_GRANDMOTHER},
"mother": R.MATERNAL_GREAT_GRANDMOTHER,
"father": R.MATERNAL_GREAT_GRANDFATHER,
"generic": R.MATERNAL_GREAT_GRANDPARENT,
},
{
"siblings": {R.MATERNAL_GRANDFATHER},
"mother": R.MATERNAL_GREAT_GRANDMOTHER,
"father": R.MATERNAL_GREAT_GRANDFATHER,
"generic": R.MATERNAL_GREAT_GRANDPARENT,
},
# PATERNAL GREAT GRANDPARENTS:
{
"siblings": {R.PATERNAL_GRANDMOTHER},
"mother": R.PATERNAL_GREAT_GRANDMOTHER,
"father": R.PATERNAL_GREAT_GRANDFATHER,
"generic": R.PATERNAL_GREAT_GRANDPARENT,
},
{
"siblings": {R.PATERNAL_GRANDFATHER},
"mother": R.PATERNAL_GREAT_GRANDMOTHER,
"father": R.PATERNAL_GREAT_GRANDFATHER,