nf-core/rnaseq
RNA sequencing analysis pipeline using STAR, RSEM, HISAT2 or Salmon with gene/isoform counts and extensive quality control.
2.0). The latest
stable release is
3.21.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.
stringPath to the output directory where the results will be saved.
string./resultsFile containing SRA/ENA/GEO identifiers one per line in order to download their associated FastQ files.
stringEmail 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.
stringOnly download metadata for public data database ids and don’t download the FastQ files.
booleanSave FastQ files after merging re-sequenced libraries in the results directory.
booleanOptions for processing reads with unique molecular identifiers
Enable UMI-based read deduplication.
booleanUMI pattern to use. Can be either ‘string’ (default) or ‘regex’.
stringstringThe UMI barcode pattern to use e.g. ‘NNNNNN’ indicates that the first 6 nucleotides of the read are from the UMI.
stringIf this option is specified, intermediate FastQ and BAM files produced by UMI-tools are also saved in the results directory.
booleanOptions for filtering reads prior to alignment
Enable the removal of reads derived from ribosomal RNA using SortMeRNA.
booleanText file containing paths to fasta files (one per line) that will be used to create the database for SortMeRNA.
string${baseDir}/assets/rrna-db-defaults.txtIf this option is specified, intermediate FastQ files containing non-rRNA reads will be saved in the results directory.
booleanReference genome related files and options required for the workflow.
Name of iGenomes reference.
stringPath to FASTA genome file.
stringPath to GTF annotation file.
stringPath to GFF3 annotation file.
stringPath to BED file containing gene intervals. This will be created from the GTF file if not specified.
stringPath to FASTA transcriptome file.
stringFASTA file to concatenate to genome FASTA file e.g. containing spike-in sequences.
stringSplice sites file required for HISAT2.
stringPath to directory or tar.gz archive for pre-built STAR index.
stringPath to directory or tar.gz archive for pre-built HISAT2 index.
stringPath to directory or tar.gz archive for pre-built RSEM index.
stringPath to directory or tar.gz archive for pre-built Salmon index.
stringMemory passed to HISAT2 build process.
integer200Specify if your GTF annotation is in GENCODE format.
booleanIf 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.
booleanOptions to adjust read trimming criteria.
Instructs 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.
booleanOptions to adjust parameters and filtering criteria for read alignments.
Specifies the alignment algorithm to use - available options are ‘star’, ‘star_rsem’ and ‘hisat2’.
stringSpecifies the pseudo aligner to use - available options are ‘salmon’. Runs in addition to ‘—aligner’.
stringWhen using pre-built STAR indices do not re-extract and use splice junctions from the GTF file.
booleanMinimum percentage of uniquely mapped reads below which samples are removed from further processing.
integer5Sequencing center information to be added to read group of BAM files.
stringWhere possible, save unaligned reads from either STAR, HISAT2 or Salmon to the results directory.
booleanSave the intermediate BAM files from the alignment step.
booleanSkip picard MarkDuplicates step.
booleanSkip all of the alignment-based processes within the pipeline.
booleanOptions for counting reads relative to gene features
‘—extraAtributes’ parameter passed to featureCounts.
stringgene_nameDefine the attribute type used to group features in the GTF file.
stringgene_idDefine the attribute type used to group feature types in the GTF file.
stringgene_biotypeBy default, the pipeline assigns reads based on the ‘exon’ attribute within the GTF file.
stringexonPerform reference-guided de novo assembly of transcripts using StringTie i.e. dont restrict to those in GTF file.
booleanSkip additional featureCounts process for biotype QC.
booleanSkip featureCounts.
booleanOptions to skip various steps within the workflow.
Specify the RSeQC modules to run.
stringbam_stat,inner_distance,infer_experiment,junction_annotation,junction_saturation,read_distribution,read_duplicationUse vst transformation instead of rlog with DESeq2.
booleanSkip bigWig file creation.
booleanSkip StringTie.
booleanSkip FastQC.
booleanSkip Preseq.
booleanSkip dupRadar.
booleanSkip Qualimap.
booleanSkip RSeQC.
booleanSkip DESeq2 PCA and heatmap plotting.
booleanSkip MultiQC.
booleanSkip all QC steps except for MultiQC.
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 configs hostname.
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.GBMaximum amount of time that can be requested for any single job.
string240.hLess 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.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.
stringRun this workflow with Conda. You can also use ‘-profile conda’ instead of providing this parameter.
boolean