Skip to main content

Cells2Stats Workflow

The cells2stats-nf workflow by Element Biosciences is a Nextflow workflow that generates cytoprofiling data from cytoprofiling runs data produced by AVITI Systems.

This workflow runs as part of ElemBio Cloud, but can also be used independently and reproducibly in any Nextflow environment (local or cloud-based).

Workflow Summary

Description

Converting raw images is the necessary first step to view cytoprofiling data in CytoCanvas. This single step pipeline uses the Cells2Stats Software to process cytoprofiling data.

Workflow Diagram

C2S Workflow Diagram

Release Notes

The workflow repository is maintained on GitHub, where you can find tags, release notes, and the latest updates.

Inputs

InputDescriptionConstraints
Run DirectoryAn AVITI24 System cytoprofiling run directory.Required
Cytoprofiling Run ManifestBy default, the run manifest in the output run directory is used. If required, an alternate run manifest can be provided to overwrite cells and pass metadata.Optional
Cell SegmentationIf required, an alternate cell segmentation file set instead of the segmentation provided in the run directory.Optional
ParametersIn addition to the dataset, parameters can tune the output.Optional

Output

Cells2Stats outputs cytoprofiling metrics and visualization data for CytoCanvas. Depending on the parameters used, the output directory may be different. See Cells2Stats outputs for specific details of output files.

Representative view of Cells2Stats output

s3://output-bucket/analysis
└── wfr_6744a40907f338871a96cd9b
├── AverageNormWellStats.csv
├── CellSegmentation
│ ├── WellA1
│ │ ├── L1R02C01S1_Cell.tif
│ │ ├── L1R02C01S1_Nuclear.tif
│ │ └── ... for n tiles in the well
│ └── ... for n wells
├── Logs
│ ├── Cells2Stats.log
│ └── Visualization.log
├── Panel.json
├── RawCellStats.csv
├── RawCellStats.parquet
├── RunManifest.json
├── RunParameters.json
├── RunStats.json
├── Versions.json
├── Wells
│ ├── WellA1
│ │ ├── B01
│ │ │ ├── L1R02C01S1_barcodes.parquet
│ │ │ └── ... for n tiles
│ │ └── ... for n batches
│ └── ... for n wells
└── visualization
├── cells
├── cyto.viz
├── locations
├── multiscale_flowcell.zarr
└── targets

Input Parameters

ParameterTypeResults
batchbooleanApplies the --batch option with the supplied value to limit which batches are used.
max_unassignedintegerApplies the --max-unassigned option with the suppled value to limit reported unassigned sequences.
skip_cellprofilerbooleanApplies the --skip-cellprofiler option to skip generating morphology features.
visualizationbooleanApplies the --visualization option to create CytoCanvas input files.
visualization_onlybooleanApplies the --visualization-only option create CytoCanvas input files without generating cell stats.
no_error_on_invalidbooleanApplies the --no-error-on-invalid option to skip invalid files.
tilestringApplies the --tileoption with the supplied value to limit which tiles are used.
wellstringApplies the --welloption with the supplied value to limit which wells are used.