Cell Ranger post-processing

Post-processing Cell Ranger datasets.

Info

ID: cellranger_postprocessing
Namespace: workflows/ingestion

Links

Source

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 1.0.1 -latest \
  -main-script target/nextflow/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 1.0.1 -latest \
  -profile docker \
  -main-script target/nextflow/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 TB
    v0(Channel.fromList)
    v2(filter)
    v18(cellbender_remove_background)
    v31(mix)
    v41(filter_with_counts)
    v54(mix)
    v63(publish)
    v90(Output)
    v0-->v2
    v2-->v18
    v18-->v31
    v2-->v31
    v31-->v41
    v41-->v54
    v31-->v54
    v54-->v63
    v63-->v90
    style v0 fill:#e3dcea,stroke:#7a4baa;
    style v2 fill:#e3dcea,stroke:#7a4baa;
    style v18 fill:#e3dcea,stroke:#7a4baa;
    style v31 fill:#e3dcea,stroke:#7a4baa;
    style v41 fill:#e3dcea,stroke:#7a4baa;
    style v54 fill:#e3dcea,stroke:#7a4baa;
    style v63 fill:#e3dcea,stroke:#7a4baa;
    style v90 fill:#e3dcea,stroke:#7a4baa;