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

Species name.

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

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

required
type: string

Path to comma-separated file containing information about the input count datasets and their related experimental design.

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

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 datasets from Expression Atlas.

Automatically etches Expression Atlas accessions for this species. and downloads the corresponding count datasets and experimental designs.

type: boolean

Keywords (separated by commas) to use when retrieving specific experiments from Expression Atlas.

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

Provide directly Expression Atlas accession(s) (separated by commas) that you want to download.

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

Options for mapping gene IDs.

Skip g:Profiler ID mapping step.

type: boolean

Path to comma-separated file containing custom gene id mappings. Each row represents a mapping from the original gene ID in your count datasets to the ensembl ID in g:Profiler.

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

Path to comma-separated file containing custom gene metadata information. Each row represents a gene and links its ensembl gene ID to its name and description.

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

Statistical options for normalisation and calculation of gene expression variation.

Tool to use for normalisation.

type: string

Number of candidate genes to keep in the final list.

type: integer
default: 1000

Threshold for KS p-value for considering samples counts as a uniform distribution.

type: number

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
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