Define where the pipeline should find input data and save output data.

Input FastQ files.

required
type: string
default: data/*R1.fastq.gz

The output directory where the results will be saved.

type: string
default: ./results

Email address for completion summary.

type: string
pattern: ^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$

Specifies if TSS-bigwigs should be generated, additionally to the TSS-bed files

type: boolean

Adjust parameters and filtering criteria for read alignments.

Alignment tool to be used

type: string

Minimum number of aligned basepairs of a read to be kept

type: integer
default: 15

Options for the reference genome indices used to align reads.

Name of iGenomes reference.

type: string

Path to FASTA genome file.

type: string

Directory / URL base for iGenomes references.

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

Do not load the iGenomes reference config.

hidden
type: boolean

Path to gtf file.

type: string

Path to star index directory.

type: string

Path to bowtie index directory.

type: string

All generated reference files will be saved to the results folder if this flag is set.

type: boolean

Adjust trimming criteria and sequences.

type: boolean

Set to cut the enzyme binding site at the 5’ end

type: boolean

Select to cut the linker at the 3’ end

type: boolean

Trim the first G at the 5’ end, if available

type: boolean

Artifacts, generated in the sequencing process, are cut if this flag is not set to false.

type: boolean

Sequence of the ecoP15 site at the 5’ end

type: string
default: CAGCAG

Sequence of the linker at the 3’ end

type: string
default: TCGTATGCCGTCTTC

Path to 5’ end artifacts

type: string
default: $projectDir/assets/artifacts_5end.fasta

Path to 3’ end artifacts

type: string
default: $projectDir/assets/artifacts_3end.fasta

Control the ribosomal RNA removal through SortMeRNA.

Select to remove ribosoamal reads with SortMeRNA

type: boolean

Select to save the ribosomal-free reads

type: boolean

Path to SortMeRNA database file

type: string
default: $projectDir/assets/rrna-db-defaults.txt

Define parameters for paraclu clustering.

Minimum cluster size

type: integer
default: 30

Minimum tags per million a cluster has to have

type: number
default: 0.2

Skip various steps within the workflow.

Skip FastQC run on input reads.

type: boolean

Skip all trimming steps.

type: boolean

Skip FastQC run on trimmed reads.

type: boolean

Skip alignment step.

type: boolean

Skip samtools stats QC step of aligned reads

type: boolean

Skip steps generating CTSS files including clustering, bed/bigwig and count table output generation.

type: boolean

Skip running RSeQC’s read distribution QC step on the clustered CTSS.

type: boolean

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

Display help text.

hidden
type: boolean

Method used to save pipeline results to output directory.

hidden
type: string

Workflow name.

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

Do not use coloured log outputs.

hidden
type: boolean

Custom config file to supply to MultiQC.

hidden
type: string

Directory to keep pipeline Nextflow logs and reports.

hidden
type: string
default: ${params.outdir}/pipeline_info

Arguments passed to Nextflow clusterOptions.

hidden
type: string
default: false

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

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

hidden
type: string
default: 240.h

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 configs hostname.

hidden
type: string

Institutional config description.

hidden
type: string

Institutional config contact information.

hidden
type: string

Institutional config URL link.

hidden
type: string