From bc85344a2c20aa62035d8624a959a2f196b2bbd4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Al=C3=A1n=20Mu=C3=B1oz?= <alan.munoz@ed.ac.uk>
Date: Tue, 24 Jan 2023 12:21:53 +0000
Subject: [PATCH] docs(pipe): move docstring to parameters
---
src/aliby/pipeline.py | 20 ++++++++++++--------
1 file changed, 12 insertions(+), 8 deletions(-)
diff --git a/src/aliby/pipeline.py b/src/aliby/pipeline.py
index e81e982e..10917b64 100644
--- a/src/aliby/pipeline.py
+++ b/src/aliby/pipeline.py
@@ -36,6 +36,18 @@ from postprocessor.core.processor import PostProcessor, PostProcessorParameters
class PipelineParameters(ParametersABC):
+ """
+ Parameters that host what is run and how. It takes a list of dictionaries, one for
+ general in collection:
+ pass dictionary for each step
+ --------------------
+ expt_id: int or str Experiment id (if integer) or local path (if string).
+ directory: str Directory into which results are dumped. Default is "../data"
+
+ Provides default parameters for the entire pipeline. This downloads the logfiles and sets the default
+ timepoints and extraction parameters from there.
+ """
+
_pool_index = None
def __init__(
@@ -58,14 +70,6 @@ class PipelineParameters(ParametersABC):
postprocessing={},
# reporting={},
):
- """
- Load unit test experiment
- :expt_id: Experiment id
- :directory: Output directory
-
- Provides default parameters for the entire pipeline. This downloads the logfiles and sets the default
- timepoints and extraction parameters from there.
- """
expt_id = general.get("expt_id", 19993)
if isinstance(expt_id, PosixPath):
expt_id = str(expt_id)
--
GitLab