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$

You will need to create a design file with information about the samples in your experiment before running the pipeline. Use this parameter to specify its location. It has to be a comma-separated file with 3 columns, and a header row. See usage docs.

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

required
type: string
default: ./results

Email address for completion summary.

type: string
pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

Set this parameter to your e-mail address to get a summary e-mail with details of the run sent to you when the workflow exits. If set in your user config file (~/.nextflow/config) then you don't need to specify this on the command line for every run.

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

If you're running offline, Nextflow will not be able to fetch the institutional config files from the internet. If you don't need them, then this is not a problem. If you do need them, you should download the files from the repo and tell Nextflow where to find them with this parameter.

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

The Nextflow publishDir option specifies which intermediate files should be saved to the output directory. This option tells the pipeline what method should be used to move these files. See Nextflow docs for details.

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})$

An email address to send a summary email to when the pipeline is completed - ONLY sent if the pipeline does not exit successfully.

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

Incoming hook URL for messaging service. Currently, MS Teams and Slack are supported.

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/

Options controlling pipeline behavior

use reference genome

type: boolean
default: true

skip assembly steps

type: boolean

Skip assembly and perform only qc.

skip alignments during qc

type: boolean

Options for ONT reads

ONT reads available?

type: boolean

collect ONT reads into a single file

type: boolean

run porechop on ONT reads

type: boolean

read length for genomescope (ONT only)

type: integer

run jellyfish on ONT reads to compute k-mer distribution and estimate genome size

type: boolean
default: true

dump jellyfish output

type: boolean

kmer length to be used for jellyfish

type: integer
default: 21

Options for HiFi reads

HiFi reads available?

type: boolean

run lima on HiFi reads?

type: boolean

file containing pacbio primers for trimming with lima

type: string

Options controlling assembly

Assembler to use. Valid choices are: 'hifiasm', 'flye', or 'flye_on_hifiasm'. flye_on_hifiasm will scaffold flye assembly (ont) on hifiasm (hifi) assembly using ragtag

type: string

expected genome size, optional

type: integer

flye mode

type: string

additional args for flye

type: string

Use hifi and ONT reads with hifiasm --ul

type: boolean

Extra arguments passed to hifiasm

type: string

Options for short reads

Short reads available?

type: boolean

trim short reads with trimgalore

type: boolean
default: true

kmer length for meryl / merqury

type: integer
default: 21

Polishing options

Polish assembly with pilon? Requires short reads

type: boolean

Polish assembly with medaka (ONT only)

type: boolean

model to use with medaka

type: string

Scaffolding options

Scaffold with longstitch?

type: boolean

Scaffolding with links?

type: boolean

Scaffold with ragtag (requires reference)?

type: boolean

Options for QC tools

Run merqury

type: boolean
default: true

Long reads that should be used for QC when both ONT and HiFi reads are provided. Options are 'ONT' or 'HIFI'

type: string

Run BUSCO?

type: boolean
default: true

Path to busco db (optional)

type: string

Busco lineage to use

type: string
default: brassicales_odb10

Run quast

type: boolean
default: true

Options controlling annotation liftover

Lift-over annotations (requires reference)?

type: boolean
default: true