From ead4481077922d7f307475e6bc04e617d6594a99 Mon Sep 17 00:00:00 2001
From: Frederick Muriuki Muriithi
Date: Mon, 1 Nov 2021 10:52:13 +0300
Subject: Stub `determine_partials`

Issue:

* Stub out `determine_partials` which is a migration of
  `web.webqtl.correlation.correlationFunction.determinePartialsByR` in GN1.

  The function in GN1 has R code from line 188 to line 344. This will need to
  be converted over to Python.

  This function will also need tests.
---
 gn3/computations/partial_correlations.py | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'gn3')

diff --git a/gn3/computations/partial_correlations.py b/gn3/computations/partial_correlations.py
index 1a6868a..fb372a9 100644
--- a/gn3/computations/partial_correlations.py
+++ b/gn3/computations/partial_correlations.py
@@ -196,6 +196,22 @@ def good_dataset_samples_indexes(
         samples_from_file.index(good) for good in
         set(samples).intersection(set(samples_from_file))))
 
+def determine_partials(
+        primary_vals, control_vals, all_target_trait_names,
+        all_target_trait_values, method):
+    """
+    This **WILL** be a migration of
+    `web.webqtl.correlation.correlationFunction.determinePartialsByR` function
+    in GeneNetwork1.
+
+    The function in GeneNetwork1 contains code written in R that is then used to
+    compute the partial correlations.
+    """
+    ## This function is not implemented at this stage
+    return tuple(
+        primary_vals, control_vals, all_target_trait_names,
+        all_target_trait_values, method)
+
 def compute_partial_correlations_fast(# pylint: disable=[R0913, R0914]
         samples, primary_vals, control_vals, database_filename,
         fetched_correlations, method: str, correlation_type: str) -> Tuple[
-- 
cgit v1.2.3