Skip to content

Commit fc97423

Browse files
committed
Clarify information in the annotation pipeline documentation
1 parent 374c9ca commit fc97423

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

annotation_pipeline/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ The ETL pipeline handles this by generating the `mp_chooser.json` file.
3131

3232
In the `mp_chooser.json` file each MP term can have different levels:
3333
- Ontology term levels: ABNORMAL, INCREASED, DECREASED.
34-
- Sex levels: FEMALE, MALE and UNSPECIFIED.
34+
- Sex levels: FEMALE, MALE, UNSPECIFIED.
35+
36+
*Note:* Sex-specific MP terms, e.g. those with FEMALE and MALE sex levels, and UNSPECIFIED, are never encountered together for the same parameter. In other words, it is either a FEMALE/MALE term or an UNSPECIFIED term available in the `mp_chooser.json` file.
3537

3638
MP term assignment logic can be seen below:
3739

@@ -51,9 +53,9 @@ graph TD;
5153
Start{Which method is used for the analysis?} --> |MM| MM[Prioritise INCREASED/DECREASED MP term, otherwise use ABNORMAL] --> A
5254
Start --> |FE or RR| FE_RR[Only use ABNORMAL MP term] --> A
5355
54-
A{"Is FEMALE/MALE specific MP term available in the mp_chooser file?"}
55-
A --> |Yes| A2[Use sex specific MP term] --> B{Is ♀/♂ call observed?}
56+
A{"Is sex-specific MP term available in the mp_chooser file?"}
57+
A --> |Yes| A2[Use FEMALE/MALE term] --> B{Is ♀ or ♂ call observed?}
5658
A --> |No| A3[Use UNSPECIFIED term] --> B
5759
58-
B --> |Yes| B1[Drop UNSPECIFIED and report sex-specific MP term]
59-
B --> |No| B2[Keep and report UNSPECIFIED MP term]
60+
B --> |Yes| B1[Drop ⚤ call and report MP term for ♀ or ♂ call]
61+
B --> |No| B2[Report ⚤ call]

0 commit comments

Comments
 (0)