Define where the pipeline should find input data and save output data.

Path to comma-separated file containing information about the samples in the experiment.

required
type: string
pattern: ^\S+\.csv$

The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.

required
type: string

Email address for completion summary.

type: string
pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

MultiQC report title. Printed as page header, used for filename if not otherwise specified.

type: string

Reference genome related files and options required for the workflow.

Name of iGenomes reference.

type: string

Path to FASTA genome file.

type: string
pattern: ^\S+\.fn?a(sta)?(\.gz)?$

Path to additional FASTA file to concatenate with main genome (optional).

type: string
pattern: ^\S+\.fn?a(sta)?(\.gz)?$

Do not load the iGenomes reference config.

hidden
type: boolean

The base path to the igenomes reference files

hidden
type: string
default: s3://ngi-igenomes/igenomes/

Parameters used to describe centralised config profiles. These should not be edited.

Git commit id for Institutional configs.

hidden
type: string
default: master

Base directory for Institutional configs.

hidden
type: string
default: https://raw.githubusercontent.com/nf-core/configs/master

Institutional config name.

hidden
type: string

Institutional config description.

hidden
type: string

Institutional config contact information.

hidden
type: string

Institutional config URL link.

hidden
type: string

Less common options for the pipeline, typically set in a config file.

Display version and exit.

hidden
type: boolean

Method used to save pipeline results to output directory.

hidden
type: string

Email address for completion summary, only when pipeline fails.

hidden
type: string
pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

Send plain-text email instead of HTML.

hidden
type: boolean

File size limit when attaching MultiQC reports to summary emails.

hidden
type: string
default: 25.MB
pattern: ^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$

Do not use coloured log outputs.

hidden
type: boolean

Incoming hook URL for messaging service

hidden
type: string

Custom config file to supply to MultiQC.

hidden
type: string

Custom logo file to supply to MultiQC. File name must also be set in the MultiQC config file

hidden
type: string

Custom MultiQC yaml file containing HTML including a methods description.

type: string

Merge all count TSV files into a single H5AD file with spatial coordinates.

type: boolean

CSV file with spatial coordinates (cell, x, y) for merging count data.

type: string

Validate the structure of the merged H5AD file.

type: boolean

Skip MultiQC report generation.

type: boolean

Boolean whether to validate parameters against the schema at runtime

hidden
type: boolean
default: true

Base URL or local path to location of pipeline test dataset files

hidden
type: string
default: https://raw.githubusercontent.com/nf-core/test-datasets/

Base URL or local path to location of modules test dataset files

hidden
type: string
default: https://raw.githubusercontent.com/nf-core/test-datasets/modules/

Suffix to add to the trace report filename. Default is the date and time in the format yyyy-MM-dd_HH-mm-ss.

hidden
type: string

Pipeline-specific parameters for STAR, UMI-tools, and GPU settings.

Path to the STAR genome index directory.

type: string

Path to the GTF annotation file for STAR.

type: string

Number of reads to subsample with seqtk. If not set (null), no subsampling is performed.

type: integer,null

UMI-tools extract method (e.g. ‘regex’, ‘tagged’, ‘string’).

type: string

Barcode pattern for UMI-tools.

type: string

Whether to extract UMI (true/false).

type: boolean

Second barcode pattern for UMI-tools (optional).

type: string,null

UMI separator for UMI-tools (optional).

type: string,null

Start position of the barcode in the read (zero-based).

type: integer
default: 9

QUIK barcode calling strategy (e.g., ‘4_7_mer_gpu_v1’, ‘accurate’).

type: string
default: 4_7_mer_gpu_v1

Distance measure for barcode matching.

type: string

Number of GPUs to use.

type: integer