nf-core/hic
Analysis of Chromosome Conformation Capture data (Hi-C)
2.0.0
). The latest
stable release is
2.1.0
.
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.
string
^\S+\.csv$
The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.
string
Email address for completion summary.
string
^([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.
string
Reference genome related files and options required for the workflow.
Name of iGenomes reference.
string
Path to FASTA genome file.
string
^\S+\.fn?s?a(sta)?(\.gz)?$
Directory / URL base for iGenomes references.
string
s3://ngi-igenomes/igenomes
Do not load the iGenomes reference config.
boolean
Full path to directory containing Bowtie index including base name. i.e. /path/to/index/base
.
string
Parameters for protocols based on restriction enzyme
Name of restriction enzyme to automatically set the restriction_site and ligation_site options (hindiii, mboi, dpnii, arima)
string
Restriction motifs used during digestion. Several motifs (comma separated) can be provided.
string
Expected motif after DNA ligation. Several motifs (comma separated) can be provided.
string
Full path to file specifying chromosome sizes (tab separated with chromosome name and size)`.
string
Full path to restriction fragment (bed) file.
string
If generated by the pipeline save the annotation and indexes in the results directory.
boolean
Parameters for protocols based on DNAse digestion
For Hi-C protocols which are not based on enzyme digestion such as DNase Hi-C
boolean
Minimum distance between loci to consider. Useful for —dnase mode to remove spurious ligation products. Only values > 0 are considered
integer
Parameters for reads aligments
Split the reads into chunks before running the pipelne
boolean
Read number per chunks if split_fastq is used
integer
20000000
Keep aligned reads with a minimum quality value
integer
10
Option for HiC-Pro end-to-end bowtie mapping
string
'--very-sensitive -L 30 --score-min L,-0.6,-0.2 --end-to-end --reorder'
Option for HiC-Pro trimmed reads mapping
string
'--very-sensitive -L 20 --score-min L,-0.6,-0.2 --end-to-end --reorder'
Save all BAM files during two-steps mapping
boolean
Options to call significant interactions
Keep duplicated reads
boolean
Keep multi-aligned reads
boolean
Maximum fragment size to consider. Only values > 0 are considered
integer
Minimum fragment size to consider. Only values > 0 are considered
integer
Maximum restriction fragment size to consider. Only values > 0 are considered
integer
Minimum restriction fragment size to consider. Only values > 0 are considered
integer
Save a BAM file where all reads are flagged by their interaction classes
boolean
Save all types of non valid read pairs in distinct output files
boolean
Options to build Hi-C contact maps
Resolution to build the maps (comma separated)
string
1000000,500000
^(\d+)(,\d+)*$
Generate raw and normalized contact maps with HiC-Pro
boolean
Filter low counts rows before HiC-Pro normalization
number
0.02
Filter high counts rows before HiC-Pro normalization
integer
Threshold for HiC-Pro ICE convergence
number
0.1
Maximum number of iteraction for HiC-Pro ICE normalization
integer
100
Maximum resolution to build mcool file
string
5000
Save raw contact maps
boolean
Set up downstream analysis from contact maps
Resolution to build count/distance plot
string
1000000
^(\d+)(,\d+)*$
Define methods for TADs calling
string
hicexplorer,insulation
Resolution to run TADs callers (comma separated)
string
40000,20000
^(\d+)(,\d+)*$
Resolution for compartments calling
string
250000
^(\d+)(,\d+)*$
Skip some steps of the pipeline
Do not build contact maps
boolean
Do not run distance/decay plot
boolean
Do not run TADs calling
boolean
Do not run compartments calling
boolean
Do not run cooler balancing normalization
boolean
Do not generate mcool file for Higlass visualization
boolean
Do not generate MultiQC report
boolean
Parameters used to describe centralised config profiles. These should not be edited.
Git commit id for Institutional configs.
string
master
Base directory for Institutional configs.
string
https://raw.githubusercontent.com/nf-core/configs/master
Institutional config name
string
Institutional config description.
string
Institutional config contact information.
string
Institutional config URL link.
string
Set the top limit for requested resources for any single job.
Maximum number of CPUs that can be requested for any single job.
integer
16
Maximum amount of memory that can be requested for any single job.
string
128.GB
^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$
Maximum amount of time that can be requested for any single job.
string
240.h
^(\d+\.?\s*(s|m|h|day)\s*)+$
Less common options for the pipeline, typically set in a config file.
Display help text.
boolean
Display version and exit.
boolean
Method used to save pipeline results to output directory.
string
Email address for completion summary, only when pipeline fails.
string
^([a-zA-Z0-9_\-\.]+)@([a-zA-Z0-9_\-\.]+)\.([a-zA-Z]{2,5})$
Send plain-text email instead of HTML.
boolean
File size limit when attaching MultiQC reports to summary emails.
string
25.MB
^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$
Do not use coloured log outputs.
boolean
Incoming hook URL for messaging service
string
Custom config file to supply to MultiQC.
string
Custom logo file to supply to MultiQC. File name must also be set in the MultiQC config file
string
Custom MultiQC yaml file containing HTML including a methods description.
string
Directory to keep pipeline Nextflow logs and reports.
string
${params.outdir}/pipeline_info
Boolean whether to validate parameters against the schema at runtime
boolean
true
Show all params when using --help
boolean