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

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

A string with NCBI taxonomic groups of the assemblies. Can be a comma-separated list.

type: string
default: all

A flag to set the busco mode for genome and annotation mode (‘genome’ is hardcoded in genome only mode).

type: string

A flag to set the busco lineage.

type: string
default: hymenoptera_odb10

A flag to set the BUSCO lineages directory (optional)

type: string

A path to a BUSCO config file (optional)

type: string

Remove intermediate files

type: boolean

Minimum number of Complete BUSCOs a sequence must have to be counted as significant ortholog-containing sequences.

type: integer

Path to FCS-GX contamination screening database.

type: string

Path to FCS GX contamination screening database

type: string

Run genomeqc on genomes only.

hidden
type: boolean

k-mer size for meryl (merqury).

type: integer
default: 21

Do not run TIDK.

type: boolean

Publish sorted fasta genome files from seqkit.

type: boolean

Publish gff files validated by AGAT.

type: boolean

Publish genomes and/or annotations of user-supplied RefSeq IDs.

type: boolean

Publish extracted protein fasta files by GFFREAD.

type: boolean

Publish orthofinder results.

type: boolean

Publish longest protein isoform fasta files.

type: boolean

Publish filtered fasta genome files from seqkit.

type: boolean

Skip these stat plots in the genome and annotation tree plot.

type: string
default: nseqs_plot

Skip these stat plots in the genome only tree plot.

type: string
default: nseqs_plot

Tool for gxf validation.

type: string

Modifies scale of the tree plot in the tree summary, default value is ‘0.0005’. Useful if tree tips overlap with the concatenated plots. Very sensitive, increase/decrease by two-fold.

type: integer
hidden
type: string