You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: annotation_pipeline/README.md
+25-8Lines changed: 25 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,22 @@ The `annotationChooser` function is processes statistical analysis results calle
19
19
The annotation pipeline requires a reference table that summarises the available MP terms for a given IMPC parameter. This reference can be retrieved from [IMPReSS](https://www.mousephenotype.org/impress/index).
20
20
The ETL pipeline handles this by generating the `mp_chooser.json` file.
21
21
22
+
- We will denote p-value calls made from:
23
+
- ♂ Male only data
24
+
- ♀ Female only data
25
+
- ⚤ All data combined
26
+
27
+
- We will denote `mp_chooser.json` terms as they are:
28
+
- MALE
29
+
- FEMALE
30
+
- UNSPECIFIED
31
+
32
+
In the `mp_chooser.json` file each MP term can have different levels:
33
+
- Ontology term levels: ABNORMAL, INCREASE, DECREASE.
34
+
- Sex levels: FEMALE, MALE and UNSPECIFIED.
35
+
36
+
MP term assignment logic can be seen below:
37
+
22
38
```mermaid
23
39
%%{
24
40
init: {
@@ -32,11 +48,12 @@ The ETL pipeline handles this by generating the `mp_chooser.json` file.
32
48
}
33
49
}%%
34
50
graph TD;
35
-
A[Repeat separately for Overall, Females and Males] --> B{Is genotype effect significant?}
36
-
B -- No --> C[Do not assign MP term]
37
-
B -- Yes --> D{Is the direction of genotype effect specified?}
38
-
D -- No --> E[Select Abnormal term]
39
-
D -- Yes --> F{Is there any conflict of direction? <br> example: Low.Decrease/High.Increase <br> or Male.Decrease/Female.Increase}
40
-
F -- No --> G[Choose an MP term corresponding to the direction of change]
41
-
F -- Yes --> H[Select Abnormal term]
42
-
```
51
+
Start{Which method is used for the analysis?} --> |MM| MM[Prioritise INCREASE/DECREASE MP term] --> A
52
+
Start --> |FE or RR| FE_RR[Only use ABNORMAL MP term] --> A
53
+
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 --> |No| A3[Use UNSPECIFIED term] --> B
57
+
58
+
B --> |Yes| B1[Drop UNSPECIFIED and report sex-specific MP term]
59
+
B --> |No| B2[Keep and report UNSPECIFIED MP term]
0 commit comments