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

Input FastQ files.

required
type: string

Input FastQ files for test only

hidden
type: string
default: undefined

Split the reads into chunks before running the pipelne

type: boolean
default: false

Read number per chunks if split_fastq is used

type: integer
default: 20000000

Specifies that the input is single-end reads.

type: boolean

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

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

Full path to directory containing Bowtie index including base name. i.e. /path/to/index/base.

type: string

Full path to file specifying chromosome sizes (tab separated with chromosome name and size)`.

type: string

Full path to restriction fragment (bed) file.

type: string

If generated by the pipeline save the annotation and indexes in the results directory.

type: boolean

Parameters for Hi-C data processing

For Hi-C protocols which are not based on enzyme digestion such as DNase Hi-C

type: boolean

Restriction motifs used during digestion. Several motifs (comma separated) can be provided.

type: string
default: 'A^AGCTT'

Expected motif after DNA ligation. Several motifs (comma separated) can be provided.

type: string
default: 'AAGCTAGCTT

Remove duplicates

type: boolean
default: true

Remove multi-mapped reads

type: boolean
default: true

Remove singleton

type: boolean
default: true

Keep aligned reads with a minimum quality value

type: integer
default: 10

Option for end-to-end bowtie mapping

type: string
default: '--very-sensitive -L 30 --score-min L,-0.6,-0.2 --end-to-end --reorder'

Option for trimmed reads mapping

type: string
default: '--very-sensitive -L 20 --score-min L,-0.6,-0.2 --end-to-end --reorder'

Save a BAM file where all reads are flagged by their interaction classes

type: boolean

Save all BAM files during two-steps mapping

type: boolean

Options to call significant interactions

Minimum distance between loci to consider. Useful for —dnase mode to remove spurious ligation products. Only values > 0 are considered

type: integer
default: O

Maximum fragment size to consider. Only values > 0 are considered

type: integer
default: 0

Minimum fragment size to consider. Only values > 0 are considered

type: integer
default: 0

Maximum restriction fragment size to consider. Only values > 0 are considered

type: integer
default: 0

Minimum restriction fragment size to consider. Only values > 0 are considered

type: integer
default: 0

Options to build Hi-C contact maps

Resolution to build the maps (comma separated)

type: string
default: '1000000,500000'

Filter low counts rows before normalization

type: string
default: 0.02

Filter high counts rows before normalization

type: integer
default: 0

Threshold for ICE convergence

type: string
default: 0.1

Maximum number of iteraction for ICE normalization

type: integer
default: 100

Skip some steps of the pipeline

Do not build contact maps

type: boolean

Do not normalize contact maps

type: boolean

Do not generate cooler file

type: boolean

Do not generate MultiQC report

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

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