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/

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

Read trimming tool to use.

type: string

Read aligner to use.

type: string

Skip alignment stage (useful for smoke tests).

type: boolean

Run Bullseye downstream stage on aligned BAM files.

type: boolean

Run Bullseye in mock mode without invoking Perl scripts.

type: boolean

Path to Bullseye Code directory containing parseBAM.pl, Find_edit_site.pl, summarize_sites.pl and quant/quantify_sites.pl.

type: string

Optional container image URI or local SIF for Bullseye local modules.

type: string

Annotation file for Find_edit_site.pl (refFlat or compatible).

type: string

Sample group label to use as control when pairing matrices for Bullseye.

type: string
default: control

Minimum coverage passed to parseBAM.pl.

type: integer
default: 10

Conversion type for Find_edit_site.pl (for example C2U).

type: string
default: C2U

Minimum edit percentage for Find_edit_site.pl.

type: number
default: 10

Maximum edit percentage for Find_edit_site.pl.

type: number
default: 80

Minimum edit fold threshold over control for Find_edit_site.pl.

type: number
default: 1.5

Minimum number of edits to report a site.

type: integer
default: 2

Minimum edited matrix coverage for Find_edit_site.pl.

type: integer
default: 10

Minimum control matrix coverage for Find_edit_site.pl.

type: integer
default: 10

Minimum replicate count used by summarize_sites.pl.

type: integer
default: 1

Coverage threshold for quantify_sites.pl.

type: integer
default: 10

Run RAC motif filtering on Bullseye quantified BED files.

type: boolean

If true, remove RAC sequence column from RAC-filtered output BED.

type: boolean
default: true

Aggregate Bullseye site-level outputs across samples using gather_sites.pl.

type: boolean

Request score matrix output from gather_sites.pl.

type: boolean
default: true

Request coverage matrix output from gather_sites.pl.

type: boolean
default: true

Request mutation-count matrix output from gather_sites.pl.

type: boolean
default: true

Run Bullseye R GLM helper on gathered coverage and mutation tables.

type: boolean

Run Bullseye GLM module in mock mode.

type: boolean

Optional container image URI for Bullseye R GLM module.

type: string

Path to functions.R used by the Bullseye GLM helper.

type: string
default: /opt/bullseye/example_data/markdown/functions.R

Path to a tab-delimited sample metadata file containing at least a ‘sample’ column.

type: string

R formula string used as design in Bullseye GLM helper.

type: string
default: ~group

Link/model option passed to Bullseye helper function.

type: string

Minimum coverage threshold passed to Bullseye GLM helper.

type: integer
default: 10

Run RustQC on aligned BAM files.

type: boolean

Command template used to run RustQC. Supports placeholders {bam} and {prefix}; if omitted, the module appends ’ ’. Command must create ‘{prefix}.rustqc.tsv’.

type: string

Container image URI or local SIF path used for the RUSTQC process.

type: string

Emit mock RustQC outputs instead of executing RustQC (for testing).

type: boolean

Path to STAR index directory.

type: string

When using pre-built STAR index, do not pass the GTF file at the mapping step.

type: boolean

Path to annotation GTF file.

type: string

Path to HISAT2 index directory.

type: string

Path to HISAT2 splice sites file.

type: string

Minimum memory threshold for HISAT2 index build to include splice-site/exon hints.

type: string
default: 8.GB

Display the help message.

type: boolean,string

Display the full detailed help message.

type: boolean

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

type: boolean

Root directory for test data and caches. Defaults to DARTSEQ_TEST_ROOT environment variable.

hidden
type: string