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

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

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

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 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
pattern: ^\S+\.fn?a(sta)?$

Options controlling assembly

Assembler to use. Valid choices are: 'hifiasm', 'flye', 'flye_on_hifiasm' or hifiasm_on_hifiasm. flye_on_hifiasm will scaffold flye assembly (ont) on hifiasm (hifi) assembly using ragtag. hifiasm_on_hifiasm will scaffold hifiasm (ont) onto hifiasm (HiFi) 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