nf-core/dualrnaseq
Analysis of Dual RNA-seq data - an experimental method for interrogating host-pathogen interactions through simultaneous RNA-seq.
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$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.
stringOption to generate mapping statistics, creating plots and summaries
booleanTo ignore igenomes reference config
stringgenomes,igenomes_base,igenomes_ignoreReference genome related files and options required for the workflow.
Name of iGenomes reference.
stringPath to FASTA genome file.
string^\S+\.fn?a(sta)?(\.gz)?$Do not load the iGenomes reference config.
booleantrueThe base path to the igenomes reference files
strings3://ngi-igenomes/igenomes/The path to the files should be enclosed by quotes ”../..”
default param???
stringChange to custom name if desired, ie Human_hela_cells
stringhostChange to custom name if desired, ie Salmonella_SL1344
stringpathogenHost genome fasta file
stringPathogen genome fasta file
stringHost GFF file
stringPathogen GFF
stringHost transcriptome file
stringPathogen transcriptome file
stringBy default, the pipeline utilizes FastQC tool for quality control of sequencing reads, run before and after trimming
Define a set of additional fastqc parameters you wish to use, except —quiet —threads —noextract flags which are already specified in the dualrnaseq pipeline
stringAdapter and read trimming is performed by either Cutadapt or BBDuk.
Additional parameters if needed
stringThese parameters are available for Salmon in both Selective Alignment and Alignment-based mode
Options for setting the library type. A = automatic detection
stringThe pipeline uses gene features from the 3rd column of the host annotative file (gff3) to extract the coordinates of transcripts to be quantified. By default, the pipeline useanscriptome_hosts exon from the —gff_host
stringexonThe pipeline uses gene features from the 3rd column of the pathogen annotative fikle (gff3) to extract the coordinates of transcripts to be quantified. By default, the pipeline uses features as gene, sRNA, tRNA and rRNA from the —gff_pathogen file.
stringgene,sRNA,tRNA,rRNAThis flag defines the gene attribute from the 9th column of the host annotative (gff3) file, where the transcript names are extracted. By default, the pipeline extracts transcript_id from the —gff_host file
stringtranscript_idThis flag defines the gene attribute from the 9th column of the pathogen annotative (gff3) file, where transcript, genes or CDS regions are extracted. By default, the pipeline extracts locus_tag from the —gff_pathogen file
stringlocus_tagStill to be described
stringexonStill to be described - requires capital P though
stringParentParameters listed below are available only for Salmon with Selective Alignment.
Run Salmon selective alignment. Does not need a value, just run —salmon_sa
booleantrueSet of additional parameters for creating an index with Salmon Selective Alignment. By default, the kmer size is set at 21. Multiple parameters can be passed - for example: —salmon_sa_index_args=“—keepDuplicates -k 21”.
string-k 21Set of additional parameters for mapping with Salmon Selective Alignment. By default, the pipeline allows soft-clipping of overhanging reads. Multiple parameters can be passed - for example: —salmon_sa_args=“—softclipOverhangs —allowDovetail”
string--softclipOverhangsOptions for Alignment-based mode
To run Salmon alignment-based mode
booleanSTAR parameter - To create a transcriptome Bam (to use with Salmon)
stringTranscriptomeSAMThe nf-core/dualrnaseq pipeline runs STAR to generate transcriptomic alignments. By default, it allows for insertions, deletions and soft-clips (Singleend option). To prohibit this behaviour, please specify IndelSoftclipSingleend
stringSingleendDefine a set of additional salmon quant parameters you wish to use in salmon alignment-based mode.
stringOptions for STAR genome alignment
To run STAR genome alignment
booleanQuant value in GFF 3rd column
stringquantparent attribule in GFF - last column
stringparentBy default, the pipeline saves unmapped reads within the main BAM file. If you want to switch off this option, set the —outSAMunmapped flag to None
stringWithinOption to limit RAM when sorting BAM file. If 0, will be set to the genome index size, which can be quite large when running on a desktop or laptop
integerAdditional args to pass to STAR
stringOptions for HTSeq count
To run HTSeq count on a aligned genome file
boolean3rd value of GFF to quantify
stringquantGene attributes from the 9th column in GFF to use
stringlocus_tagCounting mode: Options of ‘union’, ‘intersection-strict’, ‘intersection-nonempty’
stringunionFor counting non-unique reads. Options of ‘none’, ‘all’, ‘fraction’, ‘random’
stringnoneRead strand orientation. Options of ‘yes’, ‘no’, ‘reverse’
stringyesby default the bam file is sorted by position - Important for PE reads
stringposFeatures from 3rd column in GFF to use
stringgeneGene attributes from the 9th column in GFF to use
stringgene_idFeatures from 3rd column in GFF to use
stringgene,sRNA,tRNA,rRNAGene attributes from the 9th column in GFF to use
stringlocus_tagAdditional args to pass to HTSeq-count
stringParameters 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.
stringLess 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
booleantrueBase URL or local path to location of pipeline test dataset files
stringhttps://raw.githubusercontent.com/nf-core/test-datasets/Suffix to add to the trace report filename. Default is the date and time in the format yyyy-MM-dd_HH-mm-ss.
stringShow all params when using --help
boolean