Cell Ranger post-processing

Post-processing Cell Ranger datasets.

Info

ID: cellranger_postprocessing
Namespace: ingestion

Example commands

You can run the pipeline using nextflow run.

View help

You can use --help as a parameter to get an overview of the possible parameters.

nextflow run openpipelines-bio/openpipeline \
  -r 0.12.6 -latest \
  -main-script ./workflows/ingestion/cellranger_postprocessing/main.nf \
  --help

Run command

Example of params.yaml
# Inputs
id: # please fill in - example: "foo"
input: # please fill in - example: "input.h5mu"

# Outputs
# output: "$id.$key.output.output"

# Correction arguments
perform_correction: false
cellbender_epochs: 150

# Filtering arguments
# min_genes: 100
# min_counts: 1000

# Nextflow input-output arguments
publish_dir: # please fill in - example: "output/"
# param_list: "my_params.yaml"
nextflow run openpipelines-bio/openpipeline \
  -r 0.12.6 -latest \
  -profile docker \
  -main-script ./workflows/ingestion/cellranger_postprocessing/main.nf \
  -params-file params.yaml
Note

Replace -profile docker with -profile podman or -profile singularity depending on the desired backend.

Argument groups

Inputs

Name Description Attributes
--id ID of the sample. string, required, example: "foo"
--input Input h5mu file created by running Cell Ranger and converting its output to h5mu. file, required, example: "input.h5mu"

Outputs

Name Description Attributes
--output The converted h5mu file. file

Correction arguments

Name Description Attributes
--perform_correction Whether or not to run CellBender to perform count correction. boolean_true
--cellbender_epochs Number of epochs to run CellBender for. integer, default: 150

Filtering arguments

Name Description Attributes
--min_genes Minimum number of counts required for a cell to pass filtering. integer, example: 100
--min_counts Minimum number of genes expressed required for a cell to pass filtering. integer, example: 1000

Authors

  • Angela Oliveira Pisco (author)

  • Robrecht Cannoodt (author, maintainer)

Visualisation

flowchart LR
    v0(Input)
    v6(from_10xh5_to_h5mu)
    v8(join)
    v12(toSortedList)
    v14(flatMap)
    v15(filter)
    v21(cellbender_remove_background)
    v23(join)
    v27(mix)
    v26(filter)
    v28(filter)
    v34(filter_with_counts)
    v36(join)
    v40(mix)
    v39(filter)
    v46(publish)
    v48(join)
    v54(Output)
    v14-->v15
    v14-->v26
    v26-->v27
    v27-->v28
    v27-->v39
    v39-->v40
    v0-->v8
    v0-->v6
    v6-->v8
    v8-->v12
    v12-->v14
    v15-->v23
    v15-->v21
    v21-->v23
    v23-->v27
    v28-->v36
    v28-->v34
    v34-->v36
    v36-->v40
    v40-->v48
    v40-->v46
    v46-->v48
    v48-->v54