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
|
# Partial Correlation
## Description
Go to
=> http://gn1-lily.genenetwork.org/ GN1 on Lily
Search for traits 'synap*'
Select all and Add in search results.
Pick 3 and hit 'Partial'
Put one each in X, Y and Z columns
And compute against database (lower half).
That gives you a list of hits.
## Members
* fredm
* pjotp
* alex
## Tags
* assigned: fredm
* migration, in progress
## Notes
### 2021-10-15: fredm
#### UI Exploration
The example in the description above says to pick 3 traits from the search results to use for the partial correlation.
If you, however, find need to pick more than 3 traits, the following things are of note:
* There can only ever be a single **Primary** trait: if the user selects more than one, indicate an error
* At least one control trait MUST be selected. If there is no selected control trait, indicate an error
* There can only ever be a maximum of 3 **Control** traits: if the user selects more than three, indicate an error
* For **Pearson's r** and **Spearman's rho** computations (the buttons immediately below the table), there must be at least one Target trait. If the user does not provide any, indicate an error
In the lower half, the user can select the database against which the partial correlations are to be run. I still need to figure what this is about - probably read the code and ask a lot of questions as necessary.
The user can also select what to calculate, from the following list:
* Genetic Correlation, Pearson's r
* Genetic Correlation, Spearman's rho
* SGO Literature Correlation
* Tissue Correlation, Pearson's r
* Tissue Correlation, Spearman's rho
There is no indication,on the UI, of the difference between the **Pearson's r** and **Spearman's rho** with the buttons, and those in the list in the lower half of the page.
The user can also select the total number of results to return
##### Possible Correlation Errors
* Tissue Correlation Error
* Literature Correlation Error
Maybe there is even a **Genetic Correlation Error**, but I am yet to run into it - I am simply extrapolating from my exploration with the existing system.
#### Code Exploration
These are some of the (possibly) relevant files in GN1 unearthed so far:
* /web/webqtl/main.py: Entry-point -> goes to SearchResultPage then the ShowTraitPage/Collections page
* /web/webqtl/correlation/PartialCorrInputPage.py: from collections on clicking "Partial"
* /web/webqtl/cmdLine/cmdPartialCorrelationPage.py: from PartialCorrInputPage on clicking "Calculate" in the form in the second half of the page
* /web/webqtl/correlation/PartialCorrTraitPage.py: from PartialCorrInputPage on clicking "Pearson's r" or "Spearman's rho" buttons in the first half of the page
* /web/webqtl/correlation/PartialCorrDBPage.py: from cmdPartialCorrelationPage: form data is saved to file and used via CLI to compute the correlations - This seems to be the results page
The relevant javascript files used on GN1 are:
* webqtl.js: see `databaseFunc` and `validateTrait` functions
* jqueryFunction.js: see `validateTraitNumber` function
### 2021-10-18: fredm
#### UI Explorations
Some extra notes on UI that were not noted down:
* A trait can ONLY EVER BE in one category, i.e either in **Primary**, **Control**, **Target** or **Ignored** but not in more that one of those categories.
#### Code Exploration
**RISet** values should be interpreted as **group**
**strain** values should be interpreted as **sample**
There's some UI setup code after selection of the traits to use for the partial correlation. The UI setup code will probably be migrated to GN2, leaving the heavy-lifting "Partial Correlations" code, that I assume exists, for migration to GN3.
For GN3, it seems like we can simply reuse some of the trait-retrieval code migrated over when working on the clustered heatmaps.
|
