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

Path to samplesheet describing the data to be submitted (supported formats: csv, tsv, yaml, yml, json). Columns/fields depend on the pipeline mode

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

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

Parameters affecting a decision about presence/absence of tRNA and rRNA genes (RNA_presence) in a genome

Minimum percentage of 16S, 23S, and 5S rRNA gene length recovered to count the gene as present.

type: number
default: 80

Minimum number of tRNA genes detected to count tRNA as present. This value is defined by the MISAG/MIMAG standard and must not be modified.

type: number
default: 18

CAT_pack required data

Path to local CAT_pack DB

type:

Parameters used to run Checkm2

Path to pre-downloaded CheckM2 database. If omitted, downloads the version set by --checkm2_db_download_id

type:

Zenodo ID for CheckM2 database download

type: integer
default: 14897628

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

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

Use these parameters to control the flow of the pipeline execution.

Name of the submitter’s organisation (mandatory for broker accounts).

required
type: string

Mark the assemblies as a Third PArty (TPA)

type: boolean

Type of the data to be submitted

required
type: string

Upload to ENA TEST server instead of LIVE server

type: boolean
default: true

Use that flag if you are referencing private data accessions in the samplesheet

type: boolean

Date (YYYY-MM-DD) until which the newly created study stays private in ENA.

type: string
pattern: ^\d{4}-\d{2}-\d{2}$

ENA study accession (PRJ/ERP) to submit the data to

type: string

Path to a file (JSON, CSV, or TSV) with metadata for registering a new ENA study. Required if –submission_study is not set.

type: string

Webin-CLI mode for ENA interaction: submit uploads data, validate performs validation only.

type: string