nf-core/cutandrun
Analysis pipeline for CUT&RUN and CUT&TAG experiments that includes QC, support for spike-ins, IgG controls, peak calling and downstream analysis.
1.1). The latest
stable release is
3.2.2
.
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$Path to the output directory where the results will be saved.
string./resultsEmail 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.
stringSave reference data to output directory
booleanSave any technical replicates that were merged to output directory
booleanSave trimmed fastqs to output directory
booleanSave bam files aligned to the spike-in genome to output directory
booleanSave unaligned sequences to output directory
booleanSave alignment intermediates to output directory (WARNING: can be very large)
booleanSelect aligner
stringbowtie2Trim galore param
integerTrim galore param
integerTrim galore param
integerTrim galore param
integerTrim galore param
integerReference genome related files and options required for the workflow.
Name of iGenomes reference.
stringPath to bowtie2 index
stringPath to GTF annotation file
stringPath to genome blacklist
stringName of the igenome reference for the spike-in genome
stringK12-MG1655Path to spike-in bowtie2 index
stringPath to spike-in fasta
stringPath to FASTA genome file.
string^\S+\.fn?a(sta)?(\.gz)?$Directory / URL base for iGenomes references.
strings3://ngi-igenomes/igenomesDo not load the iGenomes reference config.
booleanFilter reads below a q-score threshold
integerDeduplicate non-control reads
booleanNormalisation constant
integer10000Specifies if the samplesheet contains an IgG control
booleantrueThreshold for peak calling when no IgG is present
number0.05Path to gene bed file
stringMinimum number of overlapping replicates needed for a consensus peak
integer1Run pipeline up to reference preparation
booleanRun pipeline up to input checking
booleanRun pipeline up to pre-alignment
booleanRun pipeline up to alignment
booleanRun pipeline up to q-filtering
booleanRun pipeline up to peak calling
booleanSkips fastqc reporting
booleanSkips trimming
booleanSkips de-duplication
booleanSkips scalefactor normalisation
booleanSkips reporting
booleanSkips igv session generation
booleanSkips deeptools heatmaps
booleanSkips multiqc
booleanSkip upset plot calculation
booleanParameters used to describe centralised config profiles. These should not be edited.
Git commit id for Institutional configs.
stringmasterBase directory for Institutional configs.
stringhttps://raw.githubusercontent.com/nf-core/configs/masterInstitutional config name.
stringInstitutional config description.
stringInstitutional config contact information.
stringInstitutional config URL link.
stringSet the top limit for requested resources for any single job.
Maximum number of CPUs that can be requested for any single job.
integer16Maximum amount of memory that can be requested for any single job.
string128.GB^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$Maximum amount of time that can be requested for any single job.
string240.h^(\d+\.?\s*(s|m|h|day)\s*)+$Less common options for the pipeline, typically set in a config file.
Display help text.
booleanMethod used to save pipeline results to output directory.
stringEmail 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.
booleanFile size limit when attaching MultiQC reports to summary emails.
string25.MB^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$Do not use coloured log outputs.
booleanCustom config file to supply to MultiQC.
stringDirectory to keep pipeline Nextflow logs and reports.
string${params.outdir}/pipeline_infoBoolean whether to validate parameters against the schema at runtime
booleantrueShow all params when using --help
booleanRun this workflow with Conda. You can also use ‘-profile conda’ instead of providing this parameter.
booleanInstead of directly downloading Singularity images for use with Singularity, force the workflow to pull and convert Docker containers instead.
boolean