command
» nextflow run nf-core/rnafusion -r 1.1.0 -profile test
clones in last 12 months

850

stars

45

watchers

50

last release

5 months ago

last updated

1 month ago

open issues

2

pull requests

68

collaborators

get in touch

Ask a question on Slack

Open an issue on GitHub

Introduction

The pipeline is 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.

Tool Single-end reads CPU (recommended) RAM (recommended)
Arriba No >=16 cores ~30GB
EricScript No >=16 cores ~30GB
FusionCatcher Yes >=16 cores ~64GB
fusion-report - - -
Pizzly No >=16 cores ~30GB
Squid No >=16 cores ~30GB
Star-Fusion Yes >=16 cores ~30GB
FusionInspector No >=16 cores ~30GB

For available parameters or help run:

nextflow run nf-core/rnafusion --help

Quick Start

i. Install nextflow

ii. Install one of docker, singularity or conda

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

nextflow run nf-core/rnafusion --help

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.

iv. Start running your own analysis!

nextflow run nf-core/rnafusion -profile <profile> -c './example/custom-docker.config' --reads '*_R{1,2}.fastq.gz' --arriba --star_fusion --fusioncatcher --ericscript --pizzly --squid --arriba_vis --fusion_inspector

See usage docs for all of the available options when running the pipeline.

Documentation

The nf-core/rnafusion 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

Use predefined configuration for desired Institution cluster provided at nfcore/config repository.

Credits

This pipeline was originally written by Martin Proks (@matq007) in collaboration with Karolinska Institutet, SciLifeLab and University of Southern Denmark as a master thesis. This is a follow-up development started by Rickard Hammarén (@Hammarn). Special thanks goes to all supervisors: Teresita Díaz de Ståhl, PhD., Assoc. Prof.; Monica Nistér, MD, PhD; Maxime U Garcia PhD (@MaxUlysse); Szilveszter Juhos (@szilvajuhos); Phil Ewels PhD (@ewels) and Lars Grøntved, PhD., Assoc. Prof.

Tool References

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

Citation

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

You can cite the nf-core pre-print as follows:

Ewels PA, Peltzer A, Fillinger S, Alneberg JA, Patel H, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. nf-core: Community curated bioinformatics pipelines. bioRxiv. 2019. p. 610741. doi: 10.1101/610741.

Barntumörbanken SciLifeLab
National Genomics Infrastructure University of Southern Denmark