nf-core/cageseq
CAGE-sequencing analysis pipeline with trimming, alignment and counting of CAGE tags.
22.10.6
.
Learn more.
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
./results
Email address for completion summary.
string
^([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
boolean
Adjust parameters and filtering criteria for read alignments.
Alignment tool to be used
string
Minimum number of aligned basepairs of a read to be kept
integer
15
When using pre-built STAR indices do not re-extract and use splice junctions from the GTF file.
boolean
Sequencing center information to be added to read group of BAM files.
string
Percentage of minimum number of mapped reads for files to be considered for downstream analysis.
integer
5
Reference genome related files and options required for the workflow.
Name of iGenomes reference.
string
Path to FASTA genome file.
string
^\S+\.fn?a(sta)?(\.gz)?$
Directory / URL base for iGenomes references.
string
s3://ngi-igenomes/igenomes
Do not load the iGenomes reference config.
boolean
Path to gtf file.
string
Path to star index directory.
string
Path to bowtie index directory.
string
Specify the platform used for sequencing.
string
All generated reference files will be saved to the results folder if this flag is set.
boolean
Save reads, which couldn’t be aligned.
boolean
Adjust trimming criteria and sequences.
Save trimmed reads
boolean
Set to cut the enzyme binding site at the 5’ end
boolean
true
Select to cut the linker at the 3’ end
boolean
true
Trim the first G
at the 5’ end, if available
boolean
true
Artifacts, generated in the sequencing process, are cut if this flag is not set to false.
boolean
Sequence of the ecoP15 site at the 5’ end
string
CAGCAG
Sequence of the linker at the 3’ end
string
TCGTATGCCGTCTTC
Path to 5’ end artifacts
string
$projectDir/assets/artifacts_5end.fasta
Path to 3’ end artifacts
string
$projectDir/assets/artifacts_3end.fasta
Control the ribosomal RNA removal through SortMeRNA.
Select to remove ribosoamal reads with SortMeRNA
boolean
Select to save the ribosomal-free reads
boolean
Path to SortMeRNA database file
string
$projectDir/assets/rrna-db-defaults.txt
Define parameters for paraclu clustering.
Minimum cluster size
integer
30
Minimum tags per million a cluster has to have
number
0.2
Skip various steps within the workflow.
Skip all QC processes.
boolean
Skip FastQC run on input reads.
boolean
Skip all trimming steps.
boolean
Skip FastQC run on trimmed reads.
boolean
Skip alignment step.
boolean
Skip samtools stats QC step of aligned reads
boolean
Skip steps generating CTSS files including clustering, bed/bigwig and count table output generation.
boolean
Skip generation of tag clusters from CTSS.
boolean
Skip running RSeQC’s read distribution QC step on the clustered CTSS.
boolean
Skip MultiQC step
boolean
Less common options for the pipeline, typically set in a config file.
Display help text.
boolean
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
Custom config file to supply to MultiQC.
string
MultiQC report title. Printed as page header, used for filename if not otherwise specified.
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
Run this workflow with Conda. You can also use ‘-profile conda’ instead of providing this parameter.
boolean
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*)+$
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