Skip to content

Latest commit

 

History

History
130 lines (94 loc) · 8.64 KB

README.md

File metadata and controls

130 lines (94 loc) · 8.64 KB

nf-core/rnafusion

RNA sequencing analysis pipeline with curated list of tools for detecting and visualizing fusion genes.

GitHub Actions CI Status GitHub Actions Linting Status Nextflow DOI

install with bioconda Docker

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.

The pipeline requires >=16 CPU cores and >=30GB RAM

Tool Single-end reads Version
Arriba 1.2.0
EricScript 0.5.5
FusionCatcher 1.20
Fusion-Inspector 2.2.1
fusion-report - 2.1.3
Pizzly 0.37.3
Squid 1.5
Star-Fusion 1.8.1

For available parameters or help run:

nextflow run nf-core/rnafusion --help

Quick Start

i. Install nextflow

ii. Install either Docker or Singularity for full pipeline reproducibility (please only use Conda as a last resort; see docs)

iii. Download references for all tools

nextflow run nf-core/rnafusion/download-references.nf -profile <docker/singularity/institute> \
  --download_all \
  --outdir <PATH> \
  --cosmic_usr <COSMIC_USER> --cosmic_passwd <COSMIC_PASSWD>

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 <docker/singularity/institute> \
  --reads '*_R{1,2}.fastq.gz' \
  --genomes_base 'reference_path_from_above'
  --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:

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 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

Barntumörbanken SciLifeLab
National Genomics Infrastructure University of Southern Denmark