aboutsummaryrefslogtreecommitdiff
path: root/gn3/api
diff options
context:
space:
mode:
authorAlexander Kabui2021-04-06 22:54:08 +0300
committerAlexander Kabui2021-04-06 22:54:08 +0300
commita1fcc30e84bd7201c852faf6f6a622face646ef8 (patch)
tree825fd0fa3571c4324c5c3d81dc1f6530e4a42cb1 /gn3/api
parentea610aa797d4c859fa9b9fa59a1eaa86ff7fd41c (diff)
downloadgenenetwork3-a1fcc30e84bd7201c852faf6f6a622face646ef8.tar.gz
fix Docstrings
Diffstat (limited to 'gn3/api')
-rw-r--r--gn3/api/correlation.py12
-rw-r--r--gn3/api/datasets.py8
-rw-r--r--gn3/api/traits.py7
3 files changed, 13 insertions, 14 deletions
diff --git a/gn3/api/correlation.py b/gn3/api/correlation.py
index 53ea6a7..e023cbe 100644
--- a/gn3/api/correlation.py
+++ b/gn3/api/correlation.py
@@ -15,9 +15,10 @@ correlation = Blueprint("correlation", __name__)
@correlation.route("/sample_r/<string:corr_method>", methods=["POST"])
def compute_sample_r(corr_method="pearson"):
- """correlation endpoint for computing sample r correlations\
+ """Correlation endpoint for computing sample r correlations\
api expects the trait data with has the trait and also the\
- target_dataset data"""
+ target_dataset data
+ """
correlation_input = request.get_json()
# xtodo move code below to compute_all_sampl correlation
@@ -35,9 +36,10 @@ def compute_sample_r(corr_method="pearson"):
@correlation.route("/lit_corr/<string:species>/<int:gene_id>", methods=["POST"])
def compute_lit_corr(species=None, gene_id=None):
- """api endpoint for doing lit correlation.results for lit correlation\
+ """Api endpoint for doing lit correlation.results for lit correlation\
are fetched from the database this is the only case where the db\
- might be needed for actual computing of the correlation results"""
+ might be needed for actual computing of the correlation results
+ """
database_instance = mock.Mock()
target_traits_gene_ids = request.get_json()
@@ -51,7 +53,7 @@ def compute_lit_corr(species=None, gene_id=None):
@correlation.route("/tissue_corr/<string:corr_method>", methods=["POST"])
def compute_tissue_corr(corr_method="pearson"):
- """api endpoint fr doing tissue correlation"""
+ """Api endpoint fr doing tissue correlation"""
tissue_input_data = request.get_json()
primary_tissue_dict = tissue_input_data["primary_tissue"]
target_tissues_dict_list = tissue_input_data["target_tissues"]
diff --git a/gn3/api/datasets.py b/gn3/api/datasets.py
index a6951fb..7f08de5 100644
--- a/gn3/api/datasets.py
+++ b/gn3/api/datasets.py
@@ -10,11 +10,10 @@ from gn3.experimental_db import database_connector
dataset = Blueprint("dataset", __name__)
-
@dataset.route("/create/<dataset_name>/")
@dataset.route("/create/<dataset_name>/<dataset_type>")
def create_dataset_api(dataset_name, dataset_type=None):
- """Test api/create/dataset/<dataset_name>/<dataset_type>"""
+ """Endpoint of creating dataset"""
new_dataset = create_dataset(
dataset_type=dataset_type, dataset_name=dataset_name)
@@ -27,9 +26,8 @@ def create_dataset_api(dataset_name, dataset_type=None):
@dataset.route("/fetch_traits_data/<dataset_name>/<dataset_type>")
def fetch_traits_data(dataset_name, dataset_type):
- """test fetch_traits_data/dataset_name/dataset_type"""
- # what actually brings speed issues in correlation
- # should fetch this
+ """Endpoint for fetching Trait data"""
+ # should fetch this(temp)
trait_sample_ids = [4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15,
17, 18, 19, 20, 21, 22, 24, 25, 26, 28, 29, 30, 31,
35, 36, 37, 39, 98, 99, 100, 103, 487, 105, 106, 110, 115,
diff --git a/gn3/api/traits.py b/gn3/api/traits.py
index cf445e1..0ac437d 100644
--- a/gn3/api/traits.py
+++ b/gn3/api/traits.py
@@ -12,11 +12,10 @@ from gn3.experimental_db import database_connector
trait = Blueprint("trait", __name__)
-
@trait.route("/<string:trait_name>/<string:dataset_name>")
def create_trait(trait_name, dataset_name):
- """/test:trait_name/dataset_name/type :retrieve sample\
- data for trait"""
+ """Endpoint for creating trait and fetching strain\
+ values"""
# xtodo replace the object at most this endpoint
# requires dataset_type,dataset_name ,dataset_id
@@ -38,7 +37,7 @@ def create_trait(trait_name, dataset_name):
@trait.route("/trait_info/<string:trait_name>", methods=["POST"])
def fetch_trait_info(trait_name):
- """api endpoint for fetching the trait info \
+ """Api endpoint for fetching the trait info \
expects the trait and trait dataset to have\
been created """
data = request.get_json()