Skip analysis steps

Skip QC steps

type: boolean

Skip visualisation steps

type: boolean

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.

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

Specifies which analysis type for the pipeline - either build references or analyse data

type: boolean

Path to reference folder

required
type: string

ensembl version

type: integer
default: 105

If set, starfusion references are built from scratch instead of downloaded (default)

type: boolean

Read length

type: integer
default: 100

Build or run all references/analyses

type: boolean

Build or run arriba references/analyses

type: boolean

Path to arriba references

type: string

Path to arriba reference blacklist

type: string

Path to arriba reference cytobands

type: string

Path to arriba reference known fusions

type: string

Path to arriba reference protein domain

type: string

Path to arriba output

type: string

Path to ensembl references

type: string

Build or run fusioncatcher references/analyses

type: boolean

Path to fusioncatcher output

type: string

Use limitSjdbInsertNsj with int for fusioncatcher

type: integer

Path to fusioncatcher references

type: string

Feed filtered fusionreport fusions to fusioninspector

type: boolean

Use limitSjdbInsertNsj with int for fusioninspector STAR process

type: integer

Skip fusion-report. —fusioninspector_fusions PATH needed to provide a fusion list as input

type: boolean

Path to a fusion list file built with format GENE1—GENE2

type: string

Build fusionreport references

type: boolean

Path to fusionreport references

type: string

Display fusions identified with 2 tools or more

type: boolean
default: true

Build or run pizzly references/analyses

type: boolean

Path to pizzly output

type: string

Path to pizzly references

type: string

Build or run squid references/analyses

type: boolean

Path to squid output

type: string

Path to squid references

type: string

Build or run starfusion references/analyses

type: boolean

Path to starfusion output

type: string

Path to starfusion references

type: string

Build or run starindex references/analyses

type: boolean

Path to starindex references

type: string

Run stringtie analysis

type: boolean

Path to fusions to add to the input of fusioninspector

type: string

COSMIC username

type: string

COSMIC password

type: string

Use QIAGEN instead of SANGER to download COSMIC database

type: boolean

Options to adjust read trimming criteria.

Preform trimming of reads, default: false

type: boolean

Preform fastp trimming of reads, default: false

type: boolean

Preform tail trimming of reads, default: null

type: integer

Path to adapter fasta file: default: []

type: string

Option to compress BAM files to CRAM.

List of tools for which to compress BAM file to CRAM,default: [], options: arriba, squid, starfusion. Leave no space between options

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

Path to FASTA genome index file.

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

Path to GTF genome file.

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

Path to GTF genome file.

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

Path to GTF genome file.

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

Path to GTF genome file.

type: string
pattern: ^\S+\.refflat?$

Path to ribosomal interval list.

type: string
pattern: ^\S+\.interval_list?$

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

Set the top limit for requested resources for any single job.

Maximum number of CPUs that can be requested for any single job.

hidden
type: integer
default: 16

Maximum amount of memory that can be requested for any single job.

hidden
type: string
default: 128.GB
pattern: ^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$

Maximum amount of time that can be requested for any single job.

hidden
type: string
default: 240.h
pattern: ^(\d+\.?\s*(s|m|h|d|day)\s*)+$

Less common options for the pipeline, typically set in a config file.

Display help text.

hidden
type: boolean

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

Show all params when using --help

hidden
type: boolean

Validation of parameters fails when an unrecognised parameter is found.

hidden
type: boolean

Validation of parameters in lenient more.

hidden
type: boolean

Sequencing center

hidden
type: string

Sequencing platform

hidden
type: string

Whether to ignore the GTF in STAR alignment

hidden
type: boolean