WayScience / CytoSnake

Orchestrating high-dimensional cell morphology data processing pipelines
https://cytosnake.readthedocs.io
Creative Commons Attribution 4.0 International
3 stars 3 forks source link

Implementing `dp_process` into `cytosnake` #17

Closed axiomcura closed 2 years ago

axiomcura commented 2 years ago

This pull requests introduced a new workflow into cytosnake known as dp_timelapse_process,where it processing morphological features extracted by Deep Profiler from time lapse images.

When adding this feature, also some changes had to occur in order to maintain the current usage experience of cytosnake

Module Updates!

New modules added!

setup_init.py → Handles different variations on how to setup files for workflows.

config_utils.py → handles interactions like (loading, writing) configs with cytosnake

feature_utils.py → Normally functions that focuses on dealing features is normally done in pycytominer, however, functions that are not implemented pycytominer will be placed in this module.

Module changes

errors.py → new errors added WorkflowNotFoundError and BaseFileNotFound

Updated configs!

New configs added!

dp_aggregator_config.yaml → responsible for aggregating Deep Profiler features

dp_data_configs.yaml → responsible for creating the DeepProfiler data type in order to use Deep Profiler specific functions and methods.

changes in configs

configuration.yaml → includes the newly added configs

Scripts

New scripts added!

Environment Files

New env file added!

Additional Notes

Issue: Repetitive code in the newly added scripts

New scripts contain repetitive functions calls to load config files.

Since cytosnake is not pip install-able (yet). The modules cannot be imported into script workflows since we are declaring different environments in snakemake.

Therefore, the solution to this repetitive code is to make cytosnake pip install-able and add it to our workflow environment files.

axiomcura commented 2 years ago

@gwaybio I have attended all your comments!

gwaybio commented 2 years ago

also, @axiomcura, can you please update the title of this PR to correspond to the updated workflow name. (it's no longer timelapse specific, i believe)