nf-core/riboseq
Pipeline for the analysis of ribosome profiling, or Ribo-seq (also named ribosome footprinting) data.
1.0.0). The latest
stable release is
1.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$A CSV file describing sample contrasts
string^\S+\.(csv|tsv|txt)$The output directory where the results will be saved. You have to use absolute paths to storage on Cloud infrastructure.
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.
stringReference genome related files and options required for the workflow.
Name of iGenomes reference.
stringPath to FASTA genome file.
string^\S+\.fn?a(sta)?(\.gz)?$Path to GTF annotation file.
string^\S+\.gtf(\.gz)?$Path to GFF3 annotation file.
string^\S+\.gff(\.gz)?$Path to FASTA transcriptome file.
string^\S+\.fn?a(sta)?(\.gz)?$FASTA file to concatenate to genome FASTA file e.g. containing spike-in sequences.
string^\S+\.fn?a(sta)?(\.gz)?$Path to directory or tar.gz archive for pre-built STAR index.
stringPath to directory or tar.gz archive for pre-built Salmon index.
stringSpecify if your GTF annotation is in GENCODE format.
booleanBy default, the pipeline uses the gene_name field to obtain additional gene identifiers from the input GTF file when running Salmon.
stringgene_nameDefine the attribute type used to group features in the GTF file when running Salmon.
stringgene_idDirectory / URL base for iGenomes references.
strings3://ngi-igenomes/igenomesDo not load the iGenomes reference config.
booleanOptions to adjust read trimming criteria.
Specifies the trimming tool to use - available options are ‘trimgalore’ and ‘fastp’.
stringExtra arguments to pass to Trim Galore! command in addition to defaults defined by the pipeline.
stringExtra arguments to pass to fastp command in addition to defaults defined by the pipeline.
stringMinimum number of trimmed reads below which samples are removed from further processing. Some downstream steps in the pipeline will fail if this threshold is too low.
integer10000Options for filtering reads prior to alignment
Path to comma-separated file containing a list of reference genomes to filter reads against with BBSplit. You have to also explicitly set --skip_bbsplit false if you want to use BBSplit.
stringPath to directory or tar.gz archive for pre-built BBSplit index.
stringPath to directory or tar.gz archive for pre-built sortmerna index.
stringEnable the removal of reads derived from ribosomal RNA using SortMeRNA.
booleantrueText file containing paths to fasta files (one per line) that will be used to create the database for SortMeRNA.
string${projectDir}/assets/rrna-db-defaults.txtOptions 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.
stringThe UMI barcode pattern to use if the UMI is located in read 2.
stringAfter UMI barcode extraction discard either R1 or R2 by setting this parameter to 1 or 2, respectively.
integerThe character that separates the UMI in the read name. Most likely a colon if you skipped the extraction with UMI-tools and used other software.
stringMethod to use to determine read groups by subsuming those with similar UMIs. All methods start by identifying the reads with the same mapping position, but treat similar yet nonidentical UMIs differently.
stringGenerate output stats when running “umi_tools dedup”.
booleanOptions to adjust parameters and filtering criteria for read alignments.
Specifies the alignment algorithm to use - available options are currently ‘star’.
stringKmer length passed to indexing step of pseudoaligners
integer31Create a CSI index for BAM files instead of the traditional BAI index. This will be required for genomes with larger chromosome sizes.
booleanWhen using pre-built STAR indices do not re-extract and use splice junctions from the GTF file.
booleanOverride Salmon library type inferred based on strandedness defined in meta object.
stringMinimum percentage of uniquely mapped reads below which samples are removed from further processing.
number5Sequencing center information to be added to read group of BAM files.
stringExtra arguments to pass to STAR alignment command in addition to defaults defined by the pipeline. Only available for the STAR-Salmon route.
stringExtra arguments to pass to Salmon quant command in addition to defaults defined by the pipeline.
stringOptions related to riboseq-specific analysis modules
Extra arguments to pass to the ribotish quality command in addition to defaults defined by the pipeline.
stringExtra arguments to pass to the ribotish predict command in addition to defaults defined by the pipeline.
stringExtra arguments to pass to the ribotricer prepare-orfs command in addition to defaults defined by the pipeline.
stringExtra arguments to pass to the ribotricer detect-orfs command in addition to defaults defined by the pipeline.
stringExtra arguments to pass to anota2seq in addition to defaults defined by the pipeline.
stringAdditional output files produces as intermediates that can be saved
Save FastQ files after merging re-sequenced libraries in the results directory.
booleanIf this option is specified, intermediate FastQ and BAM files produced by UMI-tools are also saved in the results directory.
booleanIf this option is specified, intermediate FastQ files containing non-rRNA reads will be saved in the results directory.
booleanIf this option is specified, FastQ files split by reference will be saved in the results directory.
booleanIf generated by the pipeline save the STAR index in the results directory.
booleanSave the trimmed FastQ files in the results directory.
booleanSave the intermediate BAM files from the alignment step.
booleantrueWhere possible, save unaligned reads from either STAR, HISAT2 or Salmon to the results directory.
booleanOptions to skip various steps within the workflow.
Skip filtering of GTF for valid scaffolds and/ or transcript IDs.
booleanSkip the ‘transcript_id’ checking component of the GTF filtering script used in the pipeline.
booleanSkip BBSplit for removal of non-reference genome reads.
booleantrueSkip the UMI extraction from the read in case the UMIs have been moved to the headers in advance of the pipeline run.
booleanSkip the adapter trimming step.
booleanSkip all of the alignment-based processes within the pipeline.
booleanSkip picard MarkDuplicates step.
booleanSkip FastQC.
booleanSkip MultiQC.
booleanSkip all QC steps except for MultiQC.
booleanSkip Ribo-TISH.
booleanSkip Riboricer.
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.
stringBase path / URL for data used in the test profiles
stringhttps://raw.githubusercontent.com/nf-core/test-datasets/riboseq/testdata/Set 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|d|day)\s*)+$Less common options for the pipeline, typically set in a config file.
Display help text.
booleanDisplay version and exit.
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.
booleanIncoming hook URL for messaging service
stringCustom config file to supply to MultiQC.
stringCustom logo file to supply to MultiQC. File name must also be set in the MultiQC config file
stringCustom MultiQC yaml file containing HTML including a methods description.
stringBoolean whether to validate parameters against the schema at runtime
booleantrueShow all params when using --help
booleanValidation of parameters fails when an unrecognised parameter is found.
booleanValidation of parameters in lenient more.
boolean