aboutsummaryrefslogtreecommitdiff
path: root/gn3/db/correlations.py
diff options
context:
space:
mode:
authorFrederick Muriuki Muriithi2021-11-23 11:49:32 +0300
committerFrederick Muriuki Muriithi2021-11-23 11:49:32 +0300
commite1fb18b9d4a3b4ab9783f58d78ff384141567a42 (patch)
tree5c0ae5ad800e5150fd313242cfb373dc83531a16 /gn3/db/correlations.py
parent575da0baf4468d27782c73b19995b3adb934ba70 (diff)
downloadgenenetwork3-e1fb18b9d4a3b4ab9783f58d78ff384141567a42.tar.gz
Update documentation for functions
Issue: https://github.com/genenetwork/gn-gemtext-threads/blob/main/topics/gn1-migration-to-gn2/partial-correlations.gmi * Document functions for posterity.
Diffstat (limited to 'gn3/db/correlations.py')
-rw-r--r--gn3/db/correlations.py12
1 files changed, 12 insertions, 0 deletions
diff --git a/gn3/db/correlations.py b/gn3/db/correlations.py
index 7daff87..5c3e7b8 100644
--- a/gn3/db/correlations.py
+++ b/gn3/db/correlations.py
@@ -408,6 +408,10 @@ def build_query_sgo_lit_corr(
"""
Build query for `SGO Literature Correlation` data, when querying the given
`temp_table` temporary table.
+
+ This is a partial migration of the
+ `web.webqtl.correlation.CorrelationPage.fetchAllDatabaseData` function in
+ GeneNetwork1.
"""
return (
(f"SELECT {db_type}.Name, {temp_table}.value, " +
@@ -424,6 +428,14 @@ def build_query_sgo_lit_corr(
2)
def build_query_tissue_corr(db_type, temp_table, sample_id_columns, joins):
+ """
+ Build query for `Tissue Correlation` data, when querying the given
+ `temp_table` temporary table.
+
+ This is a partial migration of the
+ `web.webqtl.correlation.CorrelationPage.fetchAllDatabaseData` function in
+ GeneNetwork1.
+ """
return (
(f"SELECT {db_type}.Name, {temp_table}.Correlation, " +
f"{temp_table}.PValue, " +