nf-core/rnafusion

Edit

Introduction

nf-core/rnafusion is a bioinformatics best-practice analysis pipeline for RNA sequencing analysis pipeline with curated list of tools for detecting and visualizing fusion genes.

The pipeline is built using Nextflow, a workflow tool to run tasks across multiple compute infrastructures in a very portable manner. It uses Docker/Singularity containers making installation trivial and results highly reproducible. The Nextflow DSL2 implementation of this pipeline uses one container per process which makes it much easier to maintain and update software dependencies. Where possible, these processes have been submitted to and installed from nf-core/modules in order to make them available to all nf-core pipelines, and to everyone within the Nextflow community!

IMPORTANT: conda is not supported currently. Run with singularity or docker.

GRCh38 is the only supported reference

Single-end reads are to be use as last-resort. Paired-end reads are recommended. FusionCatcher cannot be used with single-end reads shorter than 130 bp.

On release, automated continuous integration tests run the pipeline on a full-sized dataset on the AWS cloud infrastructure. This ensures that the pipeline runs on AWS, has sensible resource allocation defaults set to run on real-world datasets, and permits the persistent storage of results to benchmark between pipeline releases and other analysis sources.The results obtained from the full-sized test can be viewed on the nf-core website.

In rnafusion the full-sized test includes reference building and fusion detection. The test dataset is taken from here.

Pipeline summary

Build references

--build_references triggers a parallel workflow to build all references

1. Download ensembl fasta and gtf files
2. Create STAR index
3. Download arriba references
4. Download fusioncatcher references
5. Download pizzly references (kallisto index)
6. Download and build STAR-fusion references
7. Download fusion-report DBs

Main workflow

1. Input samplesheet check
2. Concatenate fastq files per sample
3. Read QC (FastQC)
4. Arriba subworkflow
   • STAR alignment
   • Samtool sort
   • Samtool index
   • Arriba fusion detection
5. Pizzly subworkflow
   • Kallisto quantification
   • Pizzly fusion detection
6. Squid subworkflow
   • STAR alignment
   • Samtools view: convert sam output from STAR to bam
   • Samtools sort: bam output from STAR
   • SQUID fusion detection
   • SQUID annotate
7. STAR-fusion subworkflow
   • STAR alignment
   • STAR-Fusion fusion detection
8. Fusioncatcher subworkflow
   • FusionCatcher fusion detection
9. Fusion-report subworkflow
   • Merge all fusions detected by the different tools
   • Fusion-report
10. FusionInspector subworkflow
    • FusionInspector
    • Arriba visualisation
11. Stringtie subworkflow
    • StringTie
12. Present QC for raw reads (MultiQC)
13. QC for mapped reads (QualiMap: BAM QC)
14. Index mapped reads (samtools index)
15. Collect metrics (picard CollectRnaSeqMetrics and (picard MarkDuplicates)

Quick Start

1. Install Nextflow (>=22.10.1)

2. Install any of Docker, Singularity (you can follow this tutorial), Podman, Shifter or Charliecloud for full pipeline reproducibility (you can use Conda both to install Nextflow itself and also to manage software within pipelines. Please only use it within pipelines as a last resort; see docs).

3. Download the pipeline and test it on a minimal dataset with a single command:

   nextflow run nf-core/rnafusion -profile test,YOURPROFILE --outdir <OUTDIR> -stub --all --build_references
    
   nextflow run nf-core/rnafusion -profile test,YOURPROFILE --outdir <OUTDIR> -stub --all
    

   Note that some form of configuration will be needed so that Nextflow knows how to fetch the required software. This is usually done in the form of a config profile (YOURPROFILE in the example command above). You can chain multiple config profiles in a comma-separated string.

   • The pipeline comes with config profiles called docker, singularity, podman, shifter, charliecloud and conda which instruct the pipeline to use the named tool for software management. For example, -profile test,docker.
   • Please check nf-core/configs to see if a custom config file to run nf-core pipelines already exists for your Institute. If so, you can simply use -profile <institute> in your command. This will enable either docker or singularity and set the appropriate execution settings for your local compute environment.
   • If you are using singularity, please use the nf-core download command to download images first, before running the pipeline. Setting the NXF_SINGULARITY_CACHEDIR or singularity.cacheDir Nextflow options enables you to store and re-use the images from a central location for future pipeline runs.
   • If you are using conda, it is highly recommended to use the NXF_CONDA_CACHEDIR or conda.cacheDir settings to store the environments in a central location for future pipeline runs.

4. Start running your own analysis!

nextflow run nf-core/rnafusion --input samplesheet.csv --outdir <OUTDIR> --genome GRCh38 --all -profile <docker/singularity/podman/shifter/charliecloud/institute>

nextflow run nf-core/rnafusion --input samplesheet.csv --outdir <OUTDIR> --genome GRCh37 -profile <docker/singularity/podman/shifter/charliecloud/conda/institute>

Note that paths need to be absolute and that runs with conda are not supported.

Documentation

The nf-core/rnafusion pipeline comes with documentation about the pipeline usage, parameters and output.

Credits

nf-core/rnafusion was written by Martin Proks (@matq007), Maxime Garcia (@maxulysse) and Annick Renevey (@rannick)

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

• Phil Ewels
• Rickard Hammarén
• Alexander Peltzer
• Praveen Raj

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 #rnafusion channel (you can join with this invite).

Citations

If you use nf-core/rnafusion for your analysis, please cite it using the following doi: 10.5281/zenodo.3946477

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

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.