×

nf-core/dualrnaseq

Analysis of Dual RNA-seq data - an experimental method for interrogating host-pathogen interactions through simultaneous RNA-seq.

Version: 1.0.0 Git revision: 1.0.0 Commit: Content hash:
Run:
Repository: nf-core/dualrnaseq
Workflow: main.nf

nf-core/dualrnaseq

GitHub Actions CI Status GitHub Actions Linting Status Nextflow

install with bioconda Docker Get help on Slack

Dual RNA-seq pipeline

nf-core/dualrnaseq is a bioinformatics pipeline built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It comes with docker containers making installation trivial and results highly reproducible.

Introduction

nf-core/dualrnaseq is specifically used for the analysis of Dual RNA-seq data, interrogating host-pathogen interactions through simultaneous RNA-seq.

This pipeline has been initially tested with eukaryotic host's including Human and Mouse, and pathogens including Salmonella enterica, Orientia tsutsugamushi, Streptococcus penumoniae, Escherichia coli and Mycobacterium leprae. The workflow should work with any eukaryotic and bacterial organisms with an available reference genome and annotation.

Method

The workflow merges host and pathogen genome annotations taking into account differences in annotation conventions, then processes raw data from FastQ inputs (FastQC, BBDuk), quantifies gene expression (STAR and HTSeq; STAR, Salmon and tximport; or Salmon in quasimapping mode and tximport), and summarises the results (MultiQC), as well as generating a number of custom summary plots and separate results tables for the pathogen and host. See the output documentation for more details.

Workflow

The workflow diagram below gives a simplified visual overview of how dualrnaseq has been designed.

nf-core/dualrnaseq

Documentation

The nf-core/dualrnaseq pipeline comes with documentation about the pipeline, found in the docs/ directory:

  1. Installation
  2. Pipeline configuration
  3. Running the pipeline
  4. Output and how to interpret the results
  5. Troubleshooting

Credits

nf-core/dualrnaseq was coded and written by Bozena Mika-Gospodorz and Regan Hayward.

We thank the following people for their extensive assistance in the development of this pipeline:

Contributions and Support

If you would like to contribute to this pipeline, please see the contributing guidelines.

For further information or help, don't hesitate to get in touch on the Slack #dualrnaseq channel (you can join with this invite).

Citations

You can cite the nf-core publication as follows:

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x. ReadCube: Full Access Link

An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.

102 parameter(s) in 17 group(s)

BBDuk#

Adapter and read trimming is performed by either Cutadapt or BBDuk with the following related options

Kmer length used for finding contaminants (adapters). Contaminants shorter than k will not be found. k must be at least 1

type integer
default 17

Look for shorter kmers at read tips down to this length when k-trimming or masking. 0 means disabled. Enabling this will disable maskmiddle

type integer
default 11

Maximum Hamming distance for ref kmers (subs only)

type integer
default 1

To trim reads to remove bases matching reference kmers. Avaiable options: f (don't trim), r (trim to the right - 3' adapters) l (trim to the left - 5' adapters)

type string
default r

To trim read ends to remove bases with quality below trimq

type string
default r

Cutoff to trim regions with average quality BELOW given value

type integer
default 10

Reads shorter than this after trimming will be discarded

type integer
default 18

Fasta file with adapter sequences (Default: $baseDir/data/adapters.fa)

type string
default data/adapters.fa

To run BBDuk

type boolean

Set of additional BBDuk parameters

More detail

Define a set of additional BBDuk parameters you wish to use, except -Xmx1g which is already specified in the dualrnaseq pipeline.

type string