Link Search Menu Expand Document
Table of contents
  1. Transferring and organizing input
  2. Input directory structure
  3. YAML configuration file
    1. General configurations
    2. Module configurations
  4. Markers.csv

Transferring and organizing input

CyLinter supports analysis of whole slide image (WSI) and tissue microarray (TMA) data processed by the MCMICRO image-processing pipeline. The program comes with a helper command called prep that programmatically transfers and organizes standard MCMICRO output as CyLinter input (currently only available for Mac). However, CyLinter can analyze any multiplex imaging data so long as they conform to the correct file formats: TIFF/OME-TIFF images, TIFF/OME-TIFF cell segmentation masks, TIFF/OME-TIFF cell segmentation outlines, and CSV single-cell feature tables with a cell segmentation area column labeled “Area”.


Mac users, run the following command to organize WSI DATA as CyLinter input:

prep <mcmicro_output_dir> <cylinter_input_dir>  # < > indicates a variable.

Use the “-t” flag to organize TMA DATA as CyLinter input:

prep -t <mcmicro_output_dir> <cylinter_input_dir>


For those with access to the o2 compute cluster at HMS, SSH keys may be used to transfer MCMICRO output from o2 compute to a local workstation using the following command:

prep <userID>@transfer.rc.hms.harvard.edu:<mcmicro_output_dir> <cylinter_input_dir>


Input directory structure

CyLinter assumes input files take the standard MCMICRO output format. In the below example, <sample-name> corresponds to the names of the different samples used in a particular study.

<input_dir>
├── config.yml
├── csv/
│   └── unmicst-<sample-name>.csv
├── markers.csv
├── mask/
│   └── <sample-name>.ome.tif (or tif)
├── seg/
│   └── <sample-name>.ome.tif (or tif)
└── tif/
    └── <sample-name>.ome.tif (or tif)


YAML configuration file

config.yml is the YAML configuration file passed to the cylinter command when the program is executed. It specifies general program configuration settings and module-specific parameters for a given analysis and should be included in the top-level CyLinter input directory. The config.yml file downloaded with the program is pre-configured for use with Example Data used to demonstrate CyLinter.

General configurations

ParameterDefaultDescription
inDir/Users/user/Desktop/cylinter_demoCyLinter input directory. Contains multi-channel image files (OME-TIFF or TIFF), segmentation outlines (OME-TIFF or TIFF), corresponding single-cell feature tables (CSV), config.yml, and markers.csv organized according to input directory structure.
outDir/Users/user/Desktop/cylinter_demo/outputCyLinter output directory. Path is created if it does not already exist.
sampleMetadataunmicst-<sample-name>_cellMask:
[“15”, “Glioblastoma”, “GBM”, “CANCER-TRUE”, 1]
Sample metadata dictionary: keys = file names; values = list of strings. First elements: sample names (str). Second elements: descriptive text of experimental condition (str). Third elements: abbreviation of experimental condition (str). Fourth elements: comma-delimited string of arbitrary binary declarations for computing t-statistics between two groups of samples (str dytpe). Fifth elements: replicate number specifying biological or technical replicates (int).
samplesToExclude[ ](list of strs) Sample names to exclude from analysis specified according to the first elements of sampleMetadata configuration.
markersToExclude[ ](list of strs) Immunomarkers to exclude from analysis (does not include nuclear dyes).

Module configurations

For module-specific configurations, see Modules


Markers.csv

markers.csv is a standard input file into the MCMICRO image-processing pipeline that is also used by CyLinter as immunomarker metadata. The file takes the following format and should be included in the top-level CyLinter input directory:

channel_number,cycle_number,marker_name
1,1,<DNA1>
2,1,<abx1>
3,1,<abx2>
4,1,<abx3>
5,2,<DNA2>
6,2,<abx4>
7,2,<abx5>
8,2,<abx6>
.
.
.
  • Additional metadata columns can be present in the file, but are not read by CyLinter.