Important
For reproducing the analysis and figures in our paper [1], please use this version of the code:
https://github.com/AllenCell/cvapipe_analysis/tree/nature-paper
[1] - Viana, M. P., Chen, J., Knijnenburg, T. A., Vasan, R., Yan, C., Arakaki, J. E., ... & Rafelski, S. M. (2023). Integrated intracellular organization and its variations in human iPS cells. Nature, 613(7943), 345-354.
First, create a conda environment for this project:
conda create --name cvapipe python=3.8
conda activate cvapipe
then clone this repo
git clone https://github.com/AllenCell/cvapipe_analysis.git
and install it with
cd cvapipe_analysis
pip install -e .
Alternatively, install the latest stable version from pypi by running
pip install cvapipe_analysis
This package can be used to reproduce main results shown in [1] or to generate similar results using your own data. However, before applying to your dataset, we highly recommend you to first run it for reproducibility in our test dataset to understand how the package works.
This package is fully configured through the file config.yaml. This file is divided into sections that more or less has a one-to-one mapping to existing workflow steps. Here are the main things you need to know about the configuration file:
Project
appName: cvapipe_analysis
project:
# Sufix to append to local_staging
local_staging: "path_to_your/local_staging"
overwrite: on
Set the full path where you want data and results to be stored in local_staging.
Data
data:
nucleus:
channel: "dna_segmentation"
alias: "NUC"
color: "#3AADA7"
cell:
channel: "membrane_segmentation"
alias: "MEM"
color: "#F200FF"
structure:
channel: "struct_segmentation_roof"
alias: "STR"
color: "#000000"
structure-raw:
channel: "structure"
alias: "STRRAW"
color: "#000000"
Here we provide a description of the data. Aliases must be unique and they are used in the rest of the configuration file to specify which data we are referring to. In case you are using this package on your own data, be aware that the values used in the field channel must be found in the column name_dictof your input manifets file (see the section "Running the pipeline on your own data").
Features
features:
aliases: ["NUC", "MEM", "STR"]
# SHE - Spherical harmonics expansion
SHE:
alignment:
align: on
unique: off
reference: "cell"
aliases: ["NUC", "MEM"]
# Size of Gaussian kernal used to smooth the
# images before SHE coefficients calculation
sigma: 2
# Number of SHE coefficients used to describe cell
# and nuclear shape
lmax: 16
This section is used to specify which aliases we should compute features on. In addition, which aliases we should calculate the spherical harmonics coefficies on and which type of alignment should be used.
Pre-processing
preprocessing:
remove_mitotics: on
remove_outliers: on
Here we set whether or not to remove mitotic cells or outlier from the dataset. You can turn this off when running cvapipe_analysis on your own data.
Shape Space
shapespace:
# Specify the a set of aliases here
aliases: ["NUC", "MEM"]
# Sort shape modes by volume of
sorter: "MEM"
# Percentage of exteme points to be removed
removal_pct: 1.0
# Number of principal components to be calculated
number_of_shape_modes: 8
# Map points
map_points: [-2.0, -1.5, -1.0, -0.5, 0.0, 0.5, 1.0, 1.5, 2.0]
plot:
swapxy_on_zproj: off
# limits of x and y axies in the animated GIFs
limits: [-150, 150, -80, 80]
Here we specify which aliases should be used to create a shape space. This must be a subset of the aliases specified above to have their spherical harmonics coefficients computed. In case os small datasets with only hundreds of cells, you may want to reduce the number of map points of your shape soace. The number of map points must be odd.
Intensity Parameterization
parameterization:
inner: "NUC"
outer: "MEM"
parameterize: ["RAWSTR", "STR"]
number_of_interpolating_points: 32
First we specify which alias should be used as internal and external references and the aliases that we obtain parameterization for.
Structures
structures:
"FBL": ["nucleoli [DFC)", "#A9D1E5", "{'raw': (420, 2610), 'seg': (0,30), 'avgseg': (80,160)}"]
"NPM1": ["nucleoli [GC)", "#88D1E5", "{'raw': (480, 8300), 'seg': (0,30), 'avgseg': (80,160)}"]
"SON": ["nuclear speckles", "#3292C9", "{'raw': (420, 1500), 'seg': (0,10), 'avgseg': (10,60)}"]
"SMC1A": ["cohesins", "#306598", "{'raw': (450, 630), 'seg': (0,2), 'avgseg': (0,15)}"]
"HIST1H2BJ": ["histones", "#305098", "{'raw': (450, 2885), 'seg': (0,30), 'avgseg': (10,100)}"]
"LMNB1": ["nuclear envelope", "#084AE7", "{'raw': (475,1700), 'seg': (0,30), 'avgseg': (0,60)}"]
"NUP153": ["nuclear pores", "#0840E7", "{'raw': (420, 600), 'seg': (0,15), 'avgseg': (0,50)}"]
"SEC61B": ["ER [Sec61 beta)", "#FFFFB5", "{'raw': (490,1070), 'seg': (0,30), 'avgseg': (0,100)}"]
"ATP2A2": ["ER [SERCA2)", "#FFFFA0", "{'raw': (430,670), 'seg': (0,25), 'avgseg': (0,80)}"]
"SLC25A17": ["peroxisomes", "#FFD184", "{'raw': (400,515), 'seg': (0,7), 'avgseg': (0,15)}"]
"RAB5A": ["endosomes", "#FFC846", "{'raw': (420,600), 'seg': (0,7), 'avgseg': (0,10)}"]
"TOMM20": ["mitochondria", "#FFBE37", "{'raw': (410,815), 'seg': (0,27), 'avgseg': (0,50)}"]
"LAMP1": ["lysosomes", "#AD952A", "{'raw': (440,800), 'seg': (0,27), 'avgseg': (0,30)}"]
"ST6GAL1": ["Golgi", "#B7952A", "{'raw': (400,490), 'seg': (0,17), 'avgseg': (0,30)}"]
"TUBA1B": ["microtubules", "#9D7000", "{'raw': (1100,3200), 'seg': (0,22), 'avgseg': (0,60)}"]
"CETN2": ["centrioles", "#C8E1AA", "{'raw': (440,800), 'seg': (0, 2), 'avgseg': (0,2)}"]
"GJA1": ["gap junctions", "#BEE18C", "{'raw': (420,2200), 'seg': (0,4), 'avgseg': (0,8)}"]
"TJP1": ["tight junctions", "#B4C878", "{'raw': (420,1500), 'seg': (0,8), 'avgseg': (0,20)}"]
"DSP": ["desmosomes", "#B4C864", "{'raw': (410,620), 'seg': (0,5), 'avgseg': (0,3)}"]
"CTNNB1": ["adherens junctions", "#96AA46", "{'raw': (410,750), 'seg': (0,22), 'avgseg': (5,40)}"]
"AAVS1": ["plasma membrane", "#FFD2FF", "{'raw': (505,2255), 'seg': (0,30), 'avgseg': (10,120)}"]
"ACTB": ["actin filaments", "#E6A0FF", "{'raw': (550,1300), 'seg': (0,18), 'avgseg': (0,35)}"]
"ACTN1": ["actin bundles", "#E696FF", "{'raw': (440,730), 'seg': (0,13), 'avgseg': (0,25)}"]
"MYH10": ["actomyosin bundles", "#FF82FF", "{'raw': (440,900), 'seg': (0,13), 'avgseg': (0,25)}"]
"PXN": ["matrix adhesions", "#CB1CCC", "{'raw': (410,490), 'seg': (0,5), 'avgseg': (0,5)}"]
Here we specify a dictionary with the gene names, description and color for each structure. Again, in case you are applying to your own data, make sure you specify here the values you use in the column structure_name of your manifest file (see the section "Running the pipeline on your own data"). A list with contrast values (min, max) for each structure is also specified here and will be used for the plotting functions to display single cell images of raw data, segmentation or average morphed cells (avgseg).
This analysis is currently not configured to run as a workflow. Please run steps individually.
cvapipe_analysis loaddata run
This command downloads the whole dataset of ~7Tb. For each cell in the dataset, we provide a raw 3-channels image containing fiducial markers for cell membrane and nucleus, toghether with a FP marker for one intracellular structure. We also provide segmentations for each cell in the format of 5-channels binary images. The extra two channels corresponds to roof-augmented versions of cell and intracellular structures segmentations. For more information about this, please refer to our paper [1]. Metadata about each cell can be found in the file manifest.csv. This is a table where each row corresponds to a cell.
Importantly, you can download a small test dataset composed by 300 cells chosen at random from the main dataset. To do so, please run
cvapipe_analysis loaddata run --test
This step saves the single-cell images in the folders local_staging/loaddata/crop_raw and local_staging/loaddata/crop_seg.
cvapipe_analysis computefeatures run
This step extract single-cell features, including cell, nuclear and intracellular volumes and other basic features. Here we also use aics-shparam (link) to compute the spherical harmonics coefficients for cell and nuclear shape. This step depends on step 1.
This step saves the features in the file local_staging/computefeatures/manifest.csv.
cvapipe_analysis preprocessing run
This step removes outliers and mitotic cells from the single cell dataset. This step depends on step 2.
This step saves results in the file local_staging/preprocessing/manifest.csv and the folder: local_staging/preprocessing/outliers/
xx.png: Diagnostic plots for outlier detection.
cvapipe_analysis shapemode run
Here we implement a few pre-processing steps. First, all mitotic cells are removed from the dataset. Next we use a feature-based outlier detection to detect and remove outliers form the dataset. The remaining dataset is used as input for principal component analysis. Finally, we compute cell and nuclear shape modes. This step depends on step 3.
Two output folders are produced by this step:
Folder: local_staging/shapemode/pca/
explained_variance.png: Explained variance by each principal component.feature_importance.txt: Importance of first few features of each principal component.pairwise_correlations.png: Pairwise correlations between all principal components.
Folder: local_staging/shapemode/avgshape/
xx.vtk: vtkPolyData files corresponding to 3D cell and nuclear meshes. We recommend Paraview to open these files.xx.gif: Animated GIF illustrating cell and nuclear shape modes from 3 different projections.combined.tif: Multichannel TIF that combines all animated GIFs in the same image.
cvapipe_analysis parameterization run
Here we use aics-cytoparam (link) to create parameterizations for all of the single-cell data. This steps depends on step 4 and step 3.
One output folder is produced by this step:
Folder: local_staging/parameterization/representations/
xx.tif: Multichannels TIFF image with the cell PILR.
cvapipe_analysis aggregation run
This step average multiple cell PILRs and morphs them into idealized shapes from the shape space. This step depends on step 5.
Two output folders are produced by this step:
Folder: local_staging/aggregation/repsagg/
avg-SEG-TUBA1B-DNA_MEM_PC4-B5-CODE.tif: Example of file generated. This represents the average PILR from segmented images of all TUBA1B cells that fall into bin number 5 from shape mode 4.
Folder: local_staging/aggregation/aggmorph/
avg-SEG-TUBA1B-DNA_MEM_PC4-B5.tif: Same as above but the PILR has been morphed into the cell shape corresponding to bin number 5 of shape mode 4.
cvapipe_analysis correlation run
This step computes the pair-wise correlation between PILRs of cells. This step depends on step 5.
One output folder is produced by this step:
Folder: local_staging/correlation/values/
avg-STR-NUC_MEM_PC8-1.tif: Example of file generated. Correlation matrix of between PILRs of all cells that fall into bin number 1 and shape mode 8.avg-STR-NUC_MEM_PC8-1.csv: Example of file generated. Provides the cell indices for the correlation matrix above.
cvapipe_analysis stereotypy run
This step calculates the extent to which a structure’s individual location varies. This step depends on step 5.
Two output folders are produced by this step:
Folder: local_staging/stereotypy/values
*.csv*: Stereotypy values.
Folder: local_staging/stereotypy/plots
- Resulting plots.
cvapipe_analysis concordance run
This step calculates the extent to which the structure localized relative to all the other cellular structures. This step depends on step 6.
Two output folders are produced by this step:
Folder: local_staging/concordance/values/
*.csv*: Concordance values
Folder: local_staging/concordance/plots/
- Resulting plots.
You need to specify the format of your data using a manifest.csv file. Each row of this file corresponds to a cell in your dataset. This file is requred to have the following columns:
CellId: Unique ID of the cell. Example: AB98765.
structure_name: FP structure tagged in the cell. Add something like "NA" if you don't have anything tagged for the cell. Example: TOMM20.
crop_seg: Full path to the multichannel single cell segmentation.
crop_raw: Full path to the multichannel single cell raw image.
name_dict: Dictionary that specifies the names of each channel in the two images above. Example: "{'crop_raw': ['dna_dye', 'membrane', 'gfp'], 'crop_seg': ['dna_seg', 'cell_seg', 'gfp_seg', 'gfp_seg2']}". In this case, your crop_raw images must have 3 channels once this is the number of names you provide in name_dict. Similarly, crop_seg must have 4 channels in this example.
You are ready to start using cvapipe_analysis once you have this manifest file created. To do so, you should run the step loaddata with the additional flag --csv path_to_manifest, where path_to_manifest is the full path to the manifest file that you juest created:
cvapipe_analysis loaddata run --csv path_to_manifest
All the other steps can be ran without modifications.
If you are running cvapipe_analysis on a Slurm cluster or any other cluster with sbatch capabilities, each step can be called with a flag --distribute. This will spawn many jobs to run in parallel in the cluster. Specific parameters can be set in the resources section of the YAML config file.
Free software: Allen Institute Software License