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

Reference genome related files and options required for the workflow.

Name of iGenomes reference.

hidden
type: string

The base path to the igenomes reference files

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

Do not load the iGenomes reference config.

hidden
type: boolean

Reference, variant panel and caller settings for the ABO analysis.

ABO reference FASTA (NG_006669.2, 42,144 bp) that reads are aligned to.

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

Index (.fai) of the ABO reference FASTA.

type: string
pattern: ^\S+\.fai$

ABO diagnostic variant panel (positions, calling thresholds, ISBT allele associations).

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

Panel BED file used as a fallback for the panel-filtering step.

type: string
pattern: ^\S+\.bed$

BED file restricting Clair3 calling (and gVCF reference blocks) to the ABO exon 2-7 region.

type: string
pattern: ^\S+\.bed$

URL of the Clair3 PyTorch model files (pileup.pt and full_alignment.pt) for the sequencing chemistry used.

type: string

Optional tab-delimited file mapping sequencingID to sampleName to rename samples in the final tables.

type: string

Skip the optional sample renaming step.

type: boolean
default: true

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

Boolean whether to validate parameters against the schema at runtime

hidden
type: boolean
default: true

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.

hidden
type: boolean,string

Display the full detailed help message.

hidden
type: boolean

Display hidden parameters in the help message (only works when –help or –help_full are provided).

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

Logo shown with the pipeline (defaults to the file set in nextflow.config).

hidden
type: string

Base URL or local path to location of pipeline test dataset files

hidden
type: string
default: https://raw.githubusercontent.com/nf-core/test-datasets/