Add barcode logic to CytoSnake's CLI

.pre-commit-config.yaml

@@ -28,7 +28,7 @@ repos:
     rev: v1.1.0
     hooks:
       - id: sourcery
-        args: [--diff=git diff HEAD, --no-summary]
+        args: [--diff=git diff HEAD, --fix, --no-summary]
 
   # snakemake formatting
   - repo: https://github.com/snakemake/snakefmt

configs/wf_configs/cp_process.yaml

@@ -0,0 +1,115 @@
+name: cp_process
+
+# Documentation
+docs: |
+  Description:
+  ------------
+  Traditional workflow
+
+  Workflow Steps:
+  ---------------
+  Below the workflow steps are separated in chunks.
+
+  aggregate_configs:
+    aggregates single-cell morphology at a given level of aggregation. For example
+    one can aggregate single cell at the well level. This means that all cells within
+    a well will be aggregated into a single data point containing all morphology features.
+
+  annotate_configs:
+    Adds meta data to the given dataset. This includes information regarding to well
+    position, types of perturbations, etc.
+
+  normalize_configs:
+    Applies normalization to given dataset
+
+  feature_select_configs:
+    Select features from given dataset
+
+  consensus_configs:
+    Creates a consensus profile. Consensus profiles are unique signatures that are mapped
+    to a given perturbations.
+
+annotate_configs:
+  params:
+    join_on:
+      - Metadata_well_position
+      - Image_Metadata_Well
+    add_metadata_id_to_platemap: True
+    format_broad_cmap: False
+    clean_cellprofiler: True
+    external_metadata: "none"
+    external_join_left: "none"
+    external_join_right: "none"
+    compression_options:
+      method: "gzip"
+      mtime: 1
+    float_format: null
+    cmap_args: {}
+
+aggregate_configs:
+  params:
+  strata:
+    - Metadata_Plate
+    - Metadata_Well
+  features: infer
+  operation: median
+  output_file: none
+  compute_object_count: False
+  object_feature: Metadata_ObjectNumber
+  subset_data_df: none
+  compression_options:
+    method: gzip
+    mtime: 1
+  float_format: null
+
+normalize_configs:
+  params:
+    features: infer
+    image_features: False
+    meta_features: infer
+    samples: all
+    method: mad_robustize
+    compression_options:
+      method: gzip
+      mtime: 1
+    float_format: null
+    mad_robustize_epsilon: 1.0e-18
+    spherize_center: True
+    spherize_method: ZCA-cor
+    spherize_epsilon: 1.0e-6
+
+feature_select_configs:
+  params:
+    features: infer
+    image_features: False
+    samples: all
+    operation:
+      - variance_threshold
+      - drop_na_columns
+      - correlation_threshold
+      - drop_outliers
+      - blocklist
+    na_cutoff: 0.05
+    corr_threshold: 0.9
+    corr_method: pearson
+    freq_cut: 0.05
+    unique_cut: 0.1
+    compression_options:
+      method: gzip
+      mtime: 1
+    float_format: null
+    blocklist_file: null
+    outlier_cutoff: 15
+    noise_removal_perturb_groups: null
+    noise_removal_stdev_cutoff: null
+
+consensus_config:
+  params:
+    replicate_columns:
+      - Metadata_cell_line
+      - Metadata_pert_name
+    operation: median
+    features: infer
+    compression_options: null
+    float_format: null
+    modz_args: { "method": "spearman" }

cytosnake/cli/cmd.py

@@ -9,12 +9,14 @@
 import sys
 from pathlib import Path
 
-# cytosnake imports
 from cytosnake.cli.args import CliControlPanel
 from cytosnake.cli.cli_docs import cli_docs, init_doc, run_doc
 from cytosnake.cli.exec.workflow_exec import workflow_executor
 from cytosnake.cli.setup_init import init_cp_data, init_dp_data
 from cytosnake.common.errors import ProjectExistsError, WorkflowFailedException
+
+# cytosnake imports
+from cytosnake.guards.input_guards import check_init_parameter_inputs
 from cytosnake.utils import cyto_paths
 from cytosnake.utils.cytosnake_setup import setup_cytosnake_env
 
@@ -63,6 +65,9 @@ def run_cmd() -> None:
             logging.info(msg="Formatting input files")
             init_args = args_handler.parse_init_args()
 
+            # before setup up, check the logic of the input parameters
+            check_init_parameter_inputs(user_params=init_args)
+
             # identifying which data type was added and how to set it up
             match init_args.datatype:
                 case "cell_profiler":

cytosnake/common/errors.py

@@ -91,6 +91,10 @@ class ExtensionError(BaseValueError):
     """Raised when invalid extensions are captured"""
 
 
+class BarcodeRequiredError(BaseFileNotFound):
+    """Raised when a barcode file is required"""
+
+
 # -----------------------
 # Error handling functions
 # -----------------------

cytosnake/guards/input_guards.py

@@ -0,0 +1,65 @@
+"""
+module: input_guards.py
+
+This module will handle the CytoSnake's CLI logic mostly interacting with user defined
+parameters from CytoSnake's CLI.
+
+There the logic establishes some rules of what inputs are required or what functionality
+is or not allowed.
+"""
+import pathlib
+from typing import TypeVar
+
+from cytosnake.common.errors import BarcodeRequiredError
+
+# declaring user based type hinting
+NameSpace = TypeVar("NameSpace")
+
+
+def is_barcode_required(user_params: NameSpace) -> bool:
+    """
+    user_params: NameSpace
+        Argparse.NameSpace object that contains all user provided parameters
+
+    Returns
+    -------
+    bool
+        With the given parameter inputs, True if barcodes are required else False
+    """
+
+    # getting both barcode and metadata from cli inputs
+    barcode_param = user_params.barcode
+    metadata_path = pathlib.Path(user_params.metadata).resolve(strict=True)
+
+    # counting number of platemaps in metadata
+    plate_maps_path = metadata_path / "platemaps"
+    n_platemaps = len(list(plate_maps_path.glob("*")))
+
+    # if the metadata directory has more than 1 plate maps and no barcode file return
+    # True.
+    # This indicates that a barcode is required
+    return n_platemaps > 1 and barcode_param is None
+
+
+def check_init_parameter_inputs(user_params: NameSpace) -> bool:
+    """Main wrapper to check `init` mode parameter logic.
+
+    Parameters
+    ----------
+    args : NameSpace
+        Argparse.NameSpace object that contains all user provided parameters.
+
+    Returns
+    -------
+    bool
+        True if all logic checks passed
+
+    Raises
+    ------
+    BarcodeRequiredError
+        Raised if a multiple platemaps are found but not barcode file was provided
+    """
+
+    # checking if barcode is required
+    if not is_barcode_required:
+        BarcodeRequiredError("Barcode is required, multiple platemaps found")

workflows/rules/aggregate.smk

@@ -30,9 +30,6 @@ Returns
 """
 
 
-configfile: "configs/configuration.yaml"
-
-
 rule aggregate:
     input:
         sql_files=PLATE_DATA,

workflows/rules/annotate.smk

@@ -26,9 +26,6 @@ Returns:
 """
 
 
-configfile: "configs/configuration.yaml"
-
-
 rule annotate:
     input:
         aggregate_profile=AGGREGATE_DATA,

workflows/rules/cytotable_convert.smk

@@ -15,9 +15,6 @@ Returns:
 """
 
 
-configfile: "configs/configuration.yaml"
-
-
 rule convert:
     input:
         PLATE_DATA,

workflows/rules/feature_select.smk

@@ -21,9 +21,6 @@ Returns
 """
 
 
-configfile: "configs/configuration.yaml"
-
-
 rule feature_select:
     input:
         NORMALIZED_DATA_EXPAND,

workflows/rules/generate_consensus.smk

@@ -20,9 +20,6 @@ Return:
 """
 
 
-configfile: "configs/configuration.yaml"
-
-
 rule create_consensus:
     input:
         SELECTED_FEATURE_DATA_EXPAND,

workflows/rules/normalize.smk

@@ -22,9 +22,6 @@ Output
 """
 
 
-configfile: "configs/configuration.yaml"
-
-
 rule normalize:
     input:
         CYTOTABLE_OUTPUT_DATA,

workflows/workflow/cp_process.smk

@@ -1,5 +1,11 @@
-import glob
-from cytosnake.helpers import helper_funcs as hf
+"""
+# TODO:
+[ Add docuemntation]
+"""
+
+
+# import workflow configurations
+configfile: "./configs/wf_configs/cp_process.yaml"
 
 
 # importing rule modules
@@ -11,7 +17,7 @@ include: "../rules/feature_select.smk"
 include: "../rules/generate_consensus.smk"
 
 
-# expected outputs from workflow
+# set expected outputs from workflow
 rule all:
     input:
         AGGREGATE_DATA_EXPAND,

workflows/workflow/cp_process_singlecells.smk

@@ -19,7 +19,8 @@ Returns
 """
 
 
-# importing workflow configs
+# importing workflow configs [general + workflow config]
+configfile: "./configs/configuration.yaml"
 configfile: "./configs/wf_configs/cp_process_singlecells.yaml"