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.

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/

Options for variant calling specifications

Name of a prepackaged Clair3 model.

type: string

Directory containing Clair3 model files.

type: string

minmapq value for pbcpgtools

type: number
default: 1

min-coverage value for pbcpgtools

type: number
default: 4

Genome assembly name for VEP annotation, e.g., GRCh38 or GRCh37.

type: string

Species name for VEP annotation, e.g., homo_sapiens or mus_musculus.

type: string

Specify the version of the VEP cache provided to the --vep_cache option.

type: integer
default: 115

Directory for Ensembl VEP Cache.

type: string

mutationalpattern max_delta

type: number
default: 0.06

Parameters for structural variant (SV) calling, filtering, and annotation

Tandem repeat regions BED file for SEVERUS

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

Control VCF file for SVPACK filtering

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

Reference GFF file for SVPACK annotation

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

AnnotSV cache directory

type: string

Options for copy number variation (CNV) calling and analysis

BED file defining target regions for CNVkit analysis

type: string

CNVkit reference file for copy number calling

type: string

Germline VCF file for CNV refinement

type: string

Average target region size for CNVkit

type: integer

Minimum variant depth for CNVkit analysis

type: integer
default: 20

Parameters for tumor clonality analysis using Hartwig Medical Foundation tools (AMBER, COBALT, PURPLE)

GermlineHetPon VCF file for AMBER

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

GC content profile for COBALT

type: string
pattern: ^\S+\.(cnp|txt)$

Driver gene panel for PURPLE

type: string
pattern: ^\S+\.(tsv|txt|bed)$

Known somatic hotspot variants for PURPLE

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

Known germline hotspot variants for PURPLE

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

Ensembl data directory for PURPLE

type: string

Target regions BED file for targeted sequencing

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

Diploid regions BED file for copy number baseline

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

Target region normalisation file for COBALT

type: string
pattern: ^\S+\.(tsv|txt)$

Options to skip various steps within the workflow.

Skip all QC.

type: boolean

Skip Mosdepth.

type: boolean

Skip Bamcoverage.

type: boolean

Option to skip deepsomatic SNV_INDEL caller

type: boolean

Option to skip Ensembl VEP for somatic SNV annotation

type: boolean

Option to skip VEP cache download (use existing —vep_cache instead)

type: boolean

Option to skip germline hiphase for all samples

type: boolean

Option to skip pb_cpg_tools

type: boolean

Option to skip DSS for differential methylation region detection

type: boolean

Option to skip dmr annotation

type: boolean

Option to skip somatic hiphase

type: boolean

Option to skip mutationalpattern

type: boolean

Option to skip tumor_clonality

type: boolean

Option to skip SV caller

type: boolean

Option to skip svpack for SV filtering and annotation

type: boolean

Option to skip annotsv

type: boolean

Option to skip AnnotSV annotation database installation (use existing —annotsv_cache instead)

type: boolean

Option to skip CNVKit caller

type: boolean

Option to skip HRD(Homologous Recombination Deficiency) estimation from the called SNV and SV variants

type: boolean

Skip MultiQC.

type: boolean

Options for specifying workflow type

Workflow type - can either be wes or wgs

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