about summary refs log tree commit diff
diff options
context:
space:
mode:
authorAlexander_Kabui2025-01-23 14:08:34 +0300
committerBonfaceKilz2025-02-06 12:43:15 +0300
commitc2d280ba4a8fc0f83fe1763fe4016da472e0cf72 (patch)
tree542a424cdabf5cd47e16e2e7bfa4acbd7e434bd2
parent800aecc5fc3e0f17e2a5a1280bf9aec035d40176 (diff)
downloadgenenetwork3-c2d280ba4a8fc0f83fe1763fe4016da472e0cf72.tar.gz
feat: Add module docstring for rqtl2 computations.
-rw-r--r--gn3/computations/rqtl2.py5
1 files changed, 2 insertions, 3 deletions
diff --git a/gn3/computations/rqtl2.py b/gn3/computations/rqtl2.py
index 2a9c82e..0d60ec0 100644
--- a/gn3/computations/rqtl2.py
+++ b/gn3/computations/rqtl2.py
@@ -1,8 +1,10 @@
+"""Module contains functions to parse and process rqtl2 input and output"""
 import os
 import csv
 import uuid
 import json
 
+
 def generate_rqtl2_files(data, workspace_dir):
     """Prepare data  and generate necessary CSV  files
     required to write to control_file
@@ -89,7 +91,6 @@ def prepare_files(tmpdir):
         create_file(file_path)
     return workspace_dir, input_file, output_file, log_file
 
-
 def write_input_file(input_file, workspace_dir, data):
     """
     Write input data to a json file to be passed
@@ -99,5 +100,3 @@ def write_input_file(input_file, workspace_dir, data):
         # todo choose a better variable name
         rqtl2_files = generate_rqtl2_files(data, workspace_dir)
         json.dump(rqtl2_files, file_handler)
-
-