cytosnake

Orchestrating high-dimensional cell morphology data processing pipelines

https://github.com/wayscience/cytosnake

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.6%) to scientific vocabulary

Keywords

cell-morphology microscopy-images pipeline workflow
Last synced: 6 months ago · JSON representation ·

Repository

Orchestrating high-dimensional cell morphology data processing pipelines

Basic Info
Statistics
  • Stars: 4
  • Watchers: 0
  • Forks: 3
  • Open Issues: 45
  • Releases: 3
Topics
cell-morphology microscopy-images pipeline workflow
Created about 4 years ago · Last pushed over 2 years ago
Metadata Files
Readme Contributing License Code of conduct Citation

README.md

CytoSnake: Orchestrating reproducible pipelines for processing high-dimensional systems morphology data with snakemake

Erik Serrano, Gregory P. Way University of Colorado Anschutz School of Medicine

Table of contents

About

CytoSnake is a command line interface (CLI) tool that orchestrates reproducible workflows that process high-dimensional single-cell morphology features extracted from microscopy images. CytoSnake's workflows are written in Snakemake, which is a well established workflow manager that facilitates data reproducibility, scalability, and modularity.

CytoSnake makes it easy for user to process high-dimensional cell morphology data as it requires straightforward inputs and parameters. Below is an example on how to execute CytoSnake once installed:

```bash

setting up directory

cytosnake init -d -m -b

executing workflow

cytosnake run ```

note: -b is optional, it is used if there are multiple platemap files

Installation

Install CytoSnake with conda.

bash conda install -c bioconda cytosnake

NOTE: In case you don't currently have conda installed on your system, you can access the documentation here. We recommend using Miniconda, primarily due to its lightweight installation process.

To check if CytoSnake has been successfully installed, simply type cytosnake help to see the CLI documentation:

bash cytosnake help

Workflows

CytoSnake workflows are the main instructions on how your data is going to be processed. Each workflow comes with its appropriate configuration file.

Here is an example below:

```yaml annotateconfigs: params: inputdata: platedata joinon: - Metadatawellposition - ImageMetadataWell addmetadataidtoplatemap: True formatbroadcmap: False cleancellprofiler: True externalmetadata: "none" externaljoinleft: "none" externaljoinright: "none" compressionoptions: method: "gzip" mtime: 1 floatformat: null cmap_args: {}

aggregateconfigs: params: inputdata: annotated strata: - MetadataPlate - MetadataWell features: infer operation: median outputfile: none computeobjectcount: False objectfeature: MetadataObjectNumber subsetdatadf: none compressionoptions: method: gzip mtime: 1 float_format: null

```

Above is a portion of the listed configs from the cp_process workflow. Each block represents an analytical specific step that is conducted within the workflow. In this example, annotate_configs and aggregate_configs are separate steps that occur within the cp_process workflow. Each block has the params parameter, which are the parameters associated with the analytical step. Users can edit these parameters from the defaults if they want their workflow to analyze their data in a specific way.

Overall, each workflow will have a designated workflow config file. It will contain all the steps conducted in the workflow, and users have the option to change the default parameters that are specific to their dataset.

Owner

  • Name: The Way Lab
  • Login: WayScience
  • Kind: organization
  • Location: United States of America

The Way Lab at CU Anschutz

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: CytoSnake
message: Orchestrating high-dimensional cell morphology data processing pipelines
type: software
authors:
  - given-names: Erik
    family-names: Serrano
  - given-names: Dave
    family-names: Bunten
  - given-names: Greg
    family-names: Way
identifiers:
  - type: url
    value: >-
      https://github.com/WayScience/CytoSnake
    description: Github repository of CytoSnake source code.
repository-code: >-
    https://github.com/WayScience/CytoSnake
license: CC-BY-4.0

GitHub Events

Total
  • Watch event: 1
Last Year
  • Watch event: 1

Packages

  • Total packages: 2
  • Total downloads: unknown
  • Total dependent packages: 0
    (may contain duplicates)
  • Total dependent repositories: 0
    (may contain duplicates)
  • Total versions: 4
proxy.golang.org: github.com/wayscience/cytosnake
  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.7%
Dependent repos count: 5.9%
Last synced: 6 months ago
proxy.golang.org: github.com/WayScience/CytoSnake
  • Versions: 2
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.5%
Average: 5.7%
Dependent repos count: 5.9%
Last synced: 6 months ago

Dependencies

.github/workflows/codecov.yml actions
  • codecov/codecov-action v3 composite
docs/requirements.txt pypi
  • autodoc *
  • furo ==2023.7.26
  • mock *
  • myst-parser *
  • rst-to-myst *
  • snakemake *
  • sphinx-autoapi *
  • sphinx-autobuild *
pyproject.toml pypi
setup.py pypi