nf-core/chipseq
ChIP-seq peak-calling, QC and differential analysis pipeline.
1.2.1). The latest
stable release is
2.1.0
.
Path to comma-separated file containing information about the samples in the experiment.
stringSpecifies that the input is single-end reads.
booleanEstimated fragment size used to extend single-end reads.
integerSequencing center information to be added to read group of BAM files.
stringPath 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})$Name of iGenomes reference.
stringPath to Fasta reference file.
stringPath to GTF annotation file.
stringFull path to directory containing BWA index including base name. i.e. /path/to/index/genome.fa.
stringPath to BED file containing gene intervals. This will be created from the GTF file if not specified.
stringEffective genome size parameter required by MACS2.
stringPath to blacklist regions in BED format, used for filtering alignments.
stringIf generated by the pipeline save the BWA index in the results directory.
booleanDirectory / URL base for iGenomes references.
strings3://ngi-igenomes/igenomes/Do not load the iGenomes reference config.
booleanInstructs Trim Galore to remove bp from the 5’ end of read 1 (or single-end reads).
integerInstructs Trim Galore to remove bp from the 5’ end of read 2 (paired-end reads only).
integerInstructs Trim Galore to remove bp from the 3’ end of read 1 AFTER adapter/quality trimming has been performed.
integerInstructs Trim Galore to remove bp from the 3’ end of read 2 AFTER adapter/quality trimming has been performed.
integerInstructs Trim Galore to apply the —nextseq=X option, to trim based on quality after removing poly-G tails.
integerSkip the adapter trimming step.
booleanSave the trimmed FastQ files in the results directory.
booleanDuplicate reads are not filtered from alignments.
booleanReads mapping to multiple locations are not filtered from alignments.
booleanDon’t output BWA MEM alignments with score lower than this parameter.
integerSave the intermediate BAM files from the alignment step.
booleanBAMTools JSON file with custom filters for paired-end data.
string$baseDir/assets/bamtools_filter_pe.jsonBAMTools JSON file with custom filters for single-end data.
string$baseDir/assets/bamtools_filter_se.jsonRun MACS2 in narrowPeak mode.
booleanSpecifies broad cutoff value for MACS2. Only used when —narrow_peak isnt specified.
number0.1Minimum FDR (q-value) cutoff for peak detection, —macs_fdr and —macs_pvalue are mutually exclusive.
numberp-value cutoff for peak detection, —macs_fdr and —macs_pvalue are mutually exclusive. If —macs_pvalue cutoff is set, q-value will not be calculated and reported as -1 in the final .xls file.
numberNumber of biological replicates required from a given condition for a peak to contribute to a consensus peak.
integer1Instruct MACS2 to create bedGraph files normalised to signal per million reads.
booleanSkip MACS2 peak QC plot generation.
booleanSkip annotation of MACS2 and consensus peaks with HOMER.
booleanSkip consensus peak generation, annotation and counting.
booleanUse vst transformation instead of rlog with DESeq2.
booleanSkip differential accessibility analysis.
booleanSkip FastQC.
booleanSkip Picard CollectMultipleMetrics.
booleanSkip Preseq.
booleanSkip deepTools plotProfile.
booleanSkip deepTools plotFingerprint.
booleanSkip Phantompeakqualtools.
booleanSkip IGV.
booleanSkip MultiQC.
booleanGit commit id for Institutional configs.
stringmasterBase directory for Institutional configs.
stringhttps://raw.githubusercontent.com/nf-core/configs/masterInstitutional configs hostname.
stringInstitutional config description.
stringInstitutional config contact information.
stringInstitutional config URL link.
stringMaximum number of CPUs that can be requested for any single job.
integer16Maximum amount of memory that can be requested for any single job.
string128.GBMaximum amount of time that can be requested for any single job.
string240.hDisplay help text.
booleanNumber of genomic bins to use when calculating deepTools fingerprint plot.
integer500000Method used to save pipeline results to output directory.
stringWorkflow name.
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.MBDo not use coloured log outputs.
booleanCustom config file to supply to MultiQC.
stringDirectory to keep pipeline Nextflow logs and reports.
string${params.outdir}/pipeline_infoArguments passed to Nextflow clusterOptions.
string