Skip to content

hisplan/wdl-cellranger-cellplex

Repository files navigation

wdl-cellranger-cellplex

WDLized Cell Ranger Cell Plex Pipeline

License

The pipeline code is available to everyone under the standard MIT license. However, the pipeline internally uses 10x software, so please make sure that you read and agree to 10x End User Software License.

Setup

The pipeline is a part of SCING (Single-Cell pIpeliNe Garden; pronounced as "sing" /siŋ/). For setup, please refer to this page. All the instructions below is given under the assumption that you have already configured SCING in your environment.

Create Job Files

To process a Cell Plex library, you need a total of four configuration files. Use the following example files to help you create your configuration file:

First, you need one inputs file and one labels file:

  • configs/template.inputs.json
  • configs/template.labels.json

You need two additional CSV files:

  • configs/template.cmo-ref.csv
  • configs/template.cmo-map.csv

For how to create these CSV files, please refer to the following pages:

Reference

Use one of the URLs below for the reference genome:

Type CellRangerCellPlex.reference
GRCh38 https://cf.10xgenomics.com/supp/cell-exp/refdata-gex-GRCh38-2020-A.tar.gz
mm10 https://cf.10xgenomics.com/supp/cell-exp/refdata-gex-mm10-2020-A.tar.gz

Submit Your Job

conda activate scing

./submit.sh \
    -k ~/keys/cromwell-secrets.json \
    -i configs/CellRangerCellPlex.inputs.json \
    -l configs/CellRangerCellPlex.labels.json \
    -o CellRangerCellPlex.options.aws.json