nf-core/rnasplice
rnasplice is a bioinformatics pipeline for RNA-seq alternative splicing analysis
1.0.0). The latest
stable release is
1.0.4
.
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 comma-separated file containing information about the contrasts in the experiment.
stringSource of input files.
stringThe 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.
stringSave FastQ files after merging re-sequenced libraries in the results directory.
booleanReference 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)?$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 transcript FASTA file 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_idIf generated by the pipeline save the STAR index in the results directory.
booleanDirectory / URL base for iGenomes references.
strings3://ngi-igenomes/igenomesDo not load the iGenomes reference config.
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|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.MB^\d+(\.\d+)?\.?\s*(K|M|G|T)?B$Do 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.
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.
integerSave the trimmed FastQ files in the results directory.
booleanUse this if your input FastQ files have already been trimmed outside of the workflow or if you’re very confident that there is no adapter contamination in your data.
booleanSkip TrimGalore! FastQC.
booleanMinimum number of trimmed reads below which samples are flagged in multiqc output.
integer10000Defube QC options required for the workflow.
Skip FastQC.
booleanSkip bigWig file creation.
booleantrueOptions to adjust parameters and filtering criteria for read alignments.
Specifies the alignment algorithm to use - available options are ‘star_salmon’, or ‘star’.
stringstarSpecifies the pseudo aligner to use - available options are ‘salmon’. Runs in addition to ‘—aligner’.
stringCreate 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.
stringSequencing center information to be added to read group of BAM files.
stringSkip all of the alignment-based processes within the pipeline.
booleanWhere possible, save unaligned reads from either STAR or Salmon to the results directory.
booleanSave the intermediate BAM files from the alignment step.
booleanRun rMATS workflow.
booleanThe cutoff used in the null hypothesis test for differential splicing.
number0.0001Use paired statistical model.
booleantrueThe length of each read.
integer40Detect splicing events that involve an unannotated splice site.
booleanMinimum Intron Length.
integer50Maximum exon length.
integer500Run DEXSeq differential exon usage workflow.
booleanSave pre-processed GFF annotation file.
booleanPath to GFF3 annotation file.
string^\S+\.gff(\.gz)?$Minimum alignment quality required for reads to be counted.
integer10Combine overlapping genes into a single aggregate gene.
booleantrueSave plots of the per gene DEXSeq results.
booleantruePlot the N most significant genes from the DEXSeq results.
integer10Run edgeR workflow.
booleanSave plots of the per gene edgeR results.
booleantruePlot the N most significant genes from the edgeR results.
integer10Run DEXSeq differential transcript usage workflow.
booleanGenerate estimated counts using dtuScaledTPM or scaledTPM abundance estimates.
stringMinimal number of samples where genes should be expressed.
integer6Minimal number of samples where features should be expressed.
integerMinimal proportion of samples where features should be expressed.
integerMinimal gene expression.
integer10Minimal feature expression.
integer10Minimal proportion for feature expression. This value should be between 0 and 1.
number0.1Create sashimi plots using MISO.
booleanList containing identifiers of genes to plot.
stringENSG00000004961, ENSG00000005302New-line separate file containing identifiers of genes to plot.
stringNoneRead length used to calculate coverage.
integer75Sashimi figure height (inches).
integer7Sashimi figure width (inches).
integer7Run SUPPA workflow.
booleantrueQuantify event inclusion levels (PSIs) from multiple samples.
booleantrueQuantify isoform inclusion levels (PSIs) from multiple samples.
booleantrueExpression file containing the abundances of all transcripts (ideally in TPM units).
stringRedefine genes by clustering together transcripts by genomic stranded overlap and sharing at least one exon.
booleantrueSpace separated list of events to generate.
stringSE SS MX RI FLBoundary type (only used for local AS events).
stringVariability treshold.
integer10Defines the number of nucleotides to display in the output GTF.
integer100Minimum total expression of the transcripts involved in the event.
integerCalculate differential splicing for AS events across multiple conditions with replicates.
booleantrueCalculate differential splicing for differential transcript usage across multiple conditions with replicates
booleantrueThe method to use to calculate the significance.
stringInteger indicating the number of points in the local area of the delta PSI - average TPM distribution.
integer1000Lower-bound for the absolute delta PSI value to test for significance.
integerCorrect the p-values by gene.
booleantrueIndicates if replicates across conditions are paired.
booleantrueFamily-wise error rate to use for the multiple test correction.
number0.05Use the median to calculate the Delta PSI, instead of the mean.
booleanMinimum expression (calculated as average TPM value within-replicates and between-conditions) to be included in the analysis.
integerProportion of samples with nan values allowed per condition to calculate a DeltaPSI .
integerCluster events according to PSI values across conditions
booleantrueCluster transcripts according to PSI values across conditions
booleantrueP-value threshold to consider an event significant from the dpsi file.
numberLower-bound for the absolute delta PSI value to cluster.
number0.05Maximum distance (between 0 and 1) to consider two events as members of the same cluster.
number0.05Distance metric.
stringMaximum distance in PSI space of an event to a cluster.
integerMinimum number of events required per cluster.
integer20Clustering method to use (DBSCAN, OPTICS).
string