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

TaxID of samples used as input

required
type: number

Email address for completion summary.

type: string

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

type: string

Indicates if input files are BAMs: if not, FASTQ files are assumed and alignment is run

type: boolean

Defines if pipeline is running a test or using full scale inputs

hidden
type: boolean

Choose if aligner should be bwa-mem or bwa-mem2

type: string
default: bwa-mem

Choose if multiqc has data to add kraken to report

hidden
type: boolean
default: true

Reference genome related files and options required for the workflow

Name of iGenomes reference.

type: string

Path to FASTA genome file.

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

Directory / URL base for iGenomes references.

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

Do not load the iGenomes reference config.

hidden
type: boolean

A local path to kraken database folder or compressed database file, or a URL to a compressed database file, in tar.gz format

required
type: string

A local path or a URL to a .tab krona taxonomy file; it can also receive a compressed .tab file in tar.gz format

required
type: string

Path to GFF/GTF annotation file.

hidden
type: string

Path bwa-mem indexes

hidden
type: string

Path bwa-mem2 indexes

hidden
type: string

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
default: copy

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

Do not use coloured log outputs.

hidden
type: boolean

Incoming hook URL for messaging service

hidden
type: string

Boolean whether to validate parameters against the schema at runtime

hidden
type: boolean
default: true

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

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

Path to nf-core/test-datasets

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