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$

Path or URL to a FASTA genome file for the target genome.

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

Target genome name.

type: string
default: target

Skip assembly QC.

type: boolean
default: false

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

Select the LAST seed to index the target genome.

type: string

Customise the way to mask the target genome.

type: string

Arguments for the lastdb, last-train, lastal and last-split programs.

Convert the final one-to-one alignment to a different format than MAF.

type: string
default: no_export

Make a many to many alignment

type: boolean

Path to a file containing alignment parameters or a scoring matrix. If this option is used, last-train will be skipped and alignment parameters will be the same for each query.

type: string

Arguments passed to both last-train and lastal.

type: string
default: -C2 -D1e9

Arguments passed only to lastal (useful when they are not recognised by last-train).

type: string

Mismap probability cutoff for last-split.

type: string
default: 0.00001

Customise dot-plots or skip them.

Maximum width of the dot plots, in pixels.

type: integer
default: 1000

Maximum height of the dot plots, in pixels.

type: integer
default: 10000

Font size of the sequence names on the dot plots.

type: integer
default: 14

Extra arguments passed to last-dotplot to customise the output. See https://gitlab.com/mcfrith/last/-/blob/main/doc/last-dotplot.rst.

type: string

Do not generate the one-to-many alignment dot-plot.

type: boolean

Do not generate the one-to-one alignment dot-plot.

type: boolean

Do not generate the many-to-one alignment dot-plot.

type: boolean

Do not generate the many-to-many alignment dot-plot.

type: boolean

Remove isolated alignments with the maf-filter tool.

type: boolean

Reference genome related files and options required for the workflow.

Name of iGenomes reference.

type: string

Path to FASTA genome file.

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

Do not load the iGenomes reference config.

hidden
type: boolean

The base path to the igenomes reference files

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

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