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

Scientifc species name (genus and species)

required
type: string
pattern: ^([a-zA-Z]+)[_ ]([a-zA-Z]+)[_ a-zA-Z]*$

Output directory

required
type: string

Custom datasets (counts + designs)

type: string
pattern: ^\S+\.(csv|yaml|yml|dat)$

Keywords used for selecting specific Expression Atlas / GEO accessions

type: string
pattern: (([a-zA-Z,]+))?

Only download from this platform

type: string

Only get accessions from Expression Atlas / GEO and exit.

type: boolean

Only get accessions from Expression Atlas / GEO and download the selected datasets.

type: boolean

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

Options for fetching experiment data from Expression Atlas / GEO.

Skip fetching Expression Atlas accessions

type: boolean

Fetch GEO accessions from NCBI

type: boolean

Expression Atlas / GEO accession(s) to include

type: string
pattern: ([A-Z0-9-]+,?)+

File containing Expression Atlas / GEO accession(s) to download

type: string

Expression Atlas accession(s) to exclude

type: string
pattern: ([A-Z0-9-]+,?)+

File containing Expression Atlas accession(s) to exclude

type: string

Options for mapping gene IDs.

Skip g:Profiler ID mapping step

type: boolean

Target database for g:Profiler

type: string

Custom gene id mapping file

type: string
pattern: ^\S+\.(csv|dat)$

Custom gene metadata file

type: string
pattern: ^\S+\.(csv|dat)$

Minimum quantile for the frequency of occurrence

type: number
default: 0.2

Minimum frequency of occurrence among all datasets

type: number
default: 0.1

Statistical options for normalisation and calculation of gene expression variation.

Count normalisation method

type: string

Gene length file

type: string
pattern: ^\S+\.(csv|tsv|dat)$

Target distribution for quantile normalisation

type: string

Minimum percentage of quantile expression level

type: number
default: 0.2

Options relative to assessment of stability for each gene.

Statistic descriptor for prior gene candidate selection. Either coefficient of variation (cv), or robust median absolute deviation (rcvm).

type: string

Number of candidate genes to keep for stability scoring

type: integer

Run Genorm

type: boolean

Weights for stability score calculation

type: string
pattern: ^\d+(\.\d+)?,\d+(\.\d+)?,\d+(\.\d+)?,\d+(\.\d+)?$

Options to improve pipeline scalability and robustness

Number of public dataset samples to choose randomly before downloading.

type: integer

Seed for dataset random sampling.

type: integer

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

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/

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

Display the help message.

type: boolean,string

Display the full detailed help message.

type: boolean

Display hidden parameters in the help message (only works when —help or —help_full are provided).

type: boolean