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 to comma-separated file containing information about the BAM files in the experiment.

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

Path to comma-separated file containing the counts for the samples in the experiment. Can also be a file containing just gene identifiers. In this case, count values need to be referenced in the counts_design file.

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

Path to comma-separated file containing information about the counts file.

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

Options for gene expression analysis.

Method to aggregate expression values.

type: string
default: mean

Minimum number of total counts to keep a gene in the analysis.

type: integer
default: 50

Minimum TPM to keep a gene in the analysis.

type: number
default: 1

Minimum number of total counts to keep a transcription factor in the analysis.

type: integer
default: 50

Minimum TPM to keep a transcription factor in the analysis.

type: number
default: 1

Options for motif workflow

Specifies how to handle duplicate motifs. Available options are remove (only keep first occurrence of motif), merge (average motifs with same symbol), and keep (keep all motifs and adjust background during statistical testing).

type: string

Options for merging peaks across samples.

Merge samples with the same condition and assay.

type: boolean

Minimum number of samples that a peak has to occur in to keep it while merging.

type: integer
default: 1

Options for ranking analysis.

Alpha value for the Mann-Whitney U test.

type: number
default: 0.05

Options for STARE (Significance Tool for Accessible Regulatory Elements) analysis.

Size of the window to search for binding sites.

type: integer
default: 50000

Use decay in STARE

type: boolean
default: true

Method to aggregate affinity values.

type: string

Options for ROSE (Rank Ordering of Super-Enhancers) analysis.

TSS window in base pairs

type: integer
default: 2500

Stichting window in base pairs

type: integer
default: 12500

Options for SNEEP (SNP Effect on Expression Prediction) analysis.

Path to SNEEP scale file.

type: string

Path to SNEEP motif file.

type: string

Options to skip specific pipeline steps.

Skip chromhmm. This also skips rose automatically since rose requires chromhmm input.

type: boolean

Skip rose.

type: boolean

Skip fimo. This also skips sneep automatically since sneep requires fimo input.

type: boolean

Skip sneep.

type: boolean

Options for DYNAMITE analysis.

Number of outer folds for dynamite.

type: integer
default: 3

Number of inner folds for dynamite.

type: integer
default: 6

Alpha value for dynamite.

type: number
default: 0.1

Randomize the data for dynamite.

type: boolean
default: false

Minimum regression value for dynamite.

type: number
default: 0.1

Options for ChromHMM analysis.

Number of ChromHMM states.

type: integer
default: 10

Threshold for ChromHMM enhancer detection.

type: number
default: 0.75

Comma-separated ChromHMM enhancer marks.

type: string
default: H3K27ac,H3K4me1

Comma-separated ChromHMM promoter marks.

type: string
default: H3K4me3

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 GTF gene annotation file.

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

Path to blacklist regions file.

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

Path to transcription factor motifs file.

type: string
pattern: ^\S+\.(cisbp|homer|jaspar|meme|transfac|uniprobe)?$

File containing SNPs for organism.

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

NCBI Taxonomy ID.

type: integer

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

Do not use coloured log outputs.

hidden
type: boolean

Incoming hook URL for messaging service

hidden
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