Science Score: 31.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 10 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: patkarlab
  • License: mit
  • Language: Nextflow
  • Default Branch: main
  • Size: 16.6 MB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created over 2 years ago · Last pushed over 2 years ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

nf-core/rnafusion nf-core/rnafusion

GitHub Actions CI Status GitHub Actions Linting Status AWS CI Cite with Zenodo

Nextflow run with conda run with docker run with singularity Launch on Nextflow Tower

Get help on Slack Follow on Twitter Watch on YouTube

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

| Tool | Single-end reads | Version | | --------------------------------------------------------- | :----------------: | :------: | | Arriba | :x: | 2.2.1 | | FusionCatcher | :whitecheckmark: | 1.33 | | Fusion-report | - | 2.1.5 | | Pizzly | :x: | 0.37.3 | | Squid | :x: | 1.5 | | STAR-Fusion | :whitecheckmark: | 1.10.1 |

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
  5. Pizzly subworkflow
  6. Squid subworkflow
  7. STAR-fusion subworkflow
  8. Fusioncatcher subworkflow
  9. Fusion-report subworkflow
    • Merge all fusions detected by the different tools
    • Fusion-report
  10. FusionInspector subworkflow
  11. Present QC for raw reads (MultiQC)
  12. QC for mapped reads (QualiMap: BAM QC)
  13. Index mapped reads (samtools index)
  14. Collect metrics (picard CollectRnaSeqMetrics and (picard MarkDuplicates)

Quick Start

  1. Install Nextflow (>=21.10.3)

  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:

console nextflow run nf-core/rnafusion -profile test,YOURPROFILE --outdir <OUTDIR>

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.
  1. Start running your own analysis!

console nextflow run nf-core/rnafusion --input samplesheet.csv --outdir <OUTDIR> --genome GRCh38 --all -profile <docker/singularity/podman/shifter/charliecloud/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:

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.

Owner

  • Name: Nikhil Patkar's Research Group at ACTREC, Tata Memorial Center
  • Login: patkarlab
  • Kind: user
  • Location: Kharghar, Navi Mumbai
  • Company: ACTREC, Tata Memorial Center

This is the github repository of Prof Nikhil Patkar's research group at ACTREC, Tata Memorial Center, India

Citation (CITATIONS.md)

# nf-core/rnafusion: Citations

## [nf-core](https://pubmed.ncbi.nlm.nih.gov/32055031/)

> Ewels PA, Peltzer A, Fillinger S, Patel H, Alneberg J, Wilm A, Garcia MU, Di Tommaso P, Nahnsen S. The nf-core framework for community-curated bioinformatics pipelines. Nat Biotechnol. 2020 Mar;38(3):276-278. doi: 10.1038/s41587-020-0439-x. PubMed PMID: 32055031.

## [Nextflow](https://pubmed.ncbi.nlm.nih.gov/28398311/)

> Di Tommaso P, Chatzou M, Floden EW, Barja PP, Palumbo E, Notredame C. Nextflow enables reproducible computational workflows. Nat Biotechnol. 2017 Apr 11;35(4):316-319. doi: 10.1038/nbt.3820. PubMed PMID: 28398311.

## Pipeline tools

- [FastQC](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/)

- [MultiQC](https://pubmed.ncbi.nlm.nih.gov/27312411/)

  > Ewels P, Magnusson M, Lundin S, Käller M. MultiQC: summarize analysis results for multiple tools and samples in a single report. Bioinformatics. 2016 Oct 1;32(19):3047-8. doi: 10.1093/bioinformatics/btw354. Epub 2016 Jun 16. PubMed PMID: 27312411; PubMed Central PMCID: PMC5039924.

- [Arriba](https://github.com/suhrig/arriba)

  > Uhrig S, Ellermann J, Walther T, Burkhardt P, Fröhlich M, Hutter B, Toprak UH, Neumann O, Stenzinger A, Scholl C, Fröhling S, Brors B. Accurate and efficient detection of gene fusions from RNA sequencing data.
  > Genome Research. 2021 Mar 31;448-460. doi: 10.1101/gr.257246.119. Epub 2021 Jan 13. PubMed PMID: 33441414; PubMed Central PMCID: PMC7919457.

- [FusionCatcher](https://github.com/ndaniel/fusioncatcher)

  > Nicorici D, Satalan M, Edgren H, Kangaspeska S, Murumagi A, Kallioniemi O, Virtanen S, Kilkku O. FusionCatcher – a tool for finding somatic fusion genes in paired-end RNA-sequencing data. BioRxiv, 2014 Nov. doi: 10.1101/011650.

- [Fusion-report](https://github.com/matq007/fusion-report)

  > Proks M, Genomic Profiling of a Comprehensive Nation-wide Collection of Childhood Solid Tumors, Master Thesis, Supervisors: Grøntved L, Díaz de Ståhl T, Nistér M, Ewels P, Garcia MU, Juhos S, University of Southern Denmark, 2019, unpublished.

- [Kallisto](https://pachterlab.github.io/kallisto/)

  > Bray NL, Pimentel H, Melsted P, Pachter L. Near-optimal probabilistic RNA-seq quantification. Nature Biotechnology 2016 Apr. 34, 525–527. doi:10.1038/nbt.3519. PMID: 27043002.

- [Pizzly](https://github.com/pmelsted/pizzly)
  Melsted P, Hateley S, Joseph IC, Pimentel H, Bray N, Pachter L. Fusion detection and quantification by pseudoalignment. BioRxiv, 2017 Jul. doi: 10.1101/166322.

- [SAMtools](https://pubmed.ncbi.nlm.nih.gov/19505943/)

  > Li H, Handsaker B, Wysoker A, Fennell T, Ruan J, Homer N, Marth G, Abecasis G, Durbin R; 1000 Genome Project Data Processing Subgroup. The Sequence Alignment/Map format and SAMtools. Bioinformatics. 2009 Aug 15;25(16):2078-9. doi: 10.1093/bioinformatics/btp352. Epub 2009 Jun 8. PubMed PMID: 19505943; PubMed Central PMCID: PMC2723002.

- [Squid](https://github.com/Kingsford-Group/squid)

  > Ma C, Shao M, Kingsford C. SQUID: transcriptomic structural variation detection from RNA-seq. Genome Biol 2028 Apr. 19, 52. doi: 10.1186/s13059-018-1421-5. PubMed PMID: 29650026. PubMed Central PMCID: PMC5896115.

- [STAR](https://pubmed.ncbi.nlm.nih.gov/23104886/)

  > Dobin A, Davis CA, Schlesinger F, Drenkow J, Zaleski C, Jha S, Batut P, Chaisson M, Gingeras TR. STAR: ultrafast universal RNA-seq aligner Bioinformatics. 2013 Jan 1;29(1):15-21. doi: 10.1093/bioinformatics/bts635. Epub 2012 Oct 25. PubMed PMID: 23104886; PubMed Central PMCID: PMC3530905.

- [STAR-Fusion](https://github.com/STAR-Fusion/STAR-Fusion)
  > Haas BJ, Dobin A, Li B, Stransky N, Pochet N, Regev A. Accuracy assessment of fusion transcript detection via read-mapping and de novo fusion transcript assembly-based methods. Genome Biology 2019 Oct;20,213. doi: 10.1186/s13059-019-1842-9

## Software packaging/containerisation tools

- [Anaconda](https://anaconda.com)

  > Anaconda Software Distribution. Computer software. Vers. 2-2.4.0. Anaconda, Nov. 2016. Web.

- [Bioconda](https://pubmed.ncbi.nlm.nih.gov/29967506/)

  > Grüning B, Dale R, Sjödin A, Chapman BA, Rowe J, Tomkins-Tinch CH, Valieris R, Köster J; Bioconda Team. Bioconda: sustainable and comprehensive software distribution for the life sciences. Nat Methods. 2018 Jul;15(7):475-476. doi: 10.1038/s41592-018-0046-7. PubMed PMID: 29967506.

- [BioContainers](https://pubmed.ncbi.nlm.nih.gov/28379341/)

  > da Veiga Leprevost F, Grüning B, Aflitos SA, Röst HL, Uszkoreit J, Barsnes H, Vaudel M, Moreno P, Gatto L, Weber J, Bai M, Jimenez RC, Sachsenberg T, Pfeuffer J, Alvarez RV, Griss J, Nesvizhskii AI, Perez-Riverol Y. BioContainers: an open-source and community-driven framework for software standardization. Bioinformatics. 2017 Aug 15;33(16):2580-2582. doi: 10.1093/bioinformatics/btx192. PubMed PMID: 28379341; PubMed Central PMCID: PMC5870671.

- [Docker](https://dl.acm.org/doi/10.5555/2600239.2600241)

- [Singularity](https://pubmed.ncbi.nlm.nih.gov/28494014/)
  > Kurtzer GM, Sochat V, Bauer MW. Singularity: Scientific containers for mobility of compute. PLoS One. 2017 May 11;12(5):e0177459. doi: 10.1371/journal.pone.0177459. eCollection 2017. PubMed PMID: 28494014; PubMed Central PMCID: PMC5426675.

GitHub Events

Total
Last Year

Dependencies

.github/workflows/awsfulltest.yml actions
  • nf-core/tower-action v3 composite
.github/workflows/awstest.yml actions
  • nf-core/tower-action v3 composite
.github/workflows/branch.yml actions
  • mshick/add-pr-comment v1 composite
.github/workflows/ci.yml actions
  • actions/checkout v2 composite
.github/workflows/fix-linting.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v2 composite
.github/workflows/linting.yml actions
  • actions/checkout v2 composite
  • actions/setup-node v2 composite
  • actions/setup-python v3 composite
  • actions/upload-artifact v2 composite
.github/workflows/linting_comment.yml actions
  • dawidd6/action-download-artifact v2 composite
  • marocchino/sticky-pull-request-comment v2 composite
modules/local/arriba/download/meta.yml cpan
modules/local/arriba/visualisation/meta.yml cpan
modules/local/fusioncatcher/detect/meta.yml cpan
modules/local/fusioncatcher/download/meta.yml cpan
modules/local/fusioninspector/meta.yml cpan
modules/local/fusionreport/detect/meta.yml cpan
modules/local/fusionreport/download/meta.yml cpan
modules/local/kallisto/quant/meta.yml cpan
modules/local/picard/collectrnaseqmetrics/meta.yml cpan
modules/local/pizzly/detect/meta.yml cpan
modules/local/squid/annotate/meta.yml cpan
modules/local/squid/detect/meta.yml cpan
modules/local/starfusion/build/meta.yml cpan
modules/local/starfusion/detect/meta.yml cpan
modules/local/starfusion/download/meta.yml cpan
modules/local/uscs/custom_gtftogenepred/meta.yml cpan
modules/nf-core/modules/arriba/meta.yml cpan
modules/nf-core/modules/cat/fastq/meta.yml cpan
modules/nf-core/modules/custom/dumpsoftwareversions/meta.yml cpan
modules/nf-core/modules/fastqc/meta.yml cpan
modules/nf-core/modules/kallisto/index/meta.yml cpan
modules/nf-core/modules/multiqc/meta.yml cpan
modules/nf-core/modules/picard/collectwgsmetrics/meta.yml cpan
modules/nf-core/modules/picard/markduplicates/meta.yml cpan
modules/nf-core/modules/samtools/faidx/meta.yml cpan
modules/nf-core/modules/samtools/index/meta.yml cpan
modules/nf-core/modules/samtools/sort/meta.yml cpan
modules/nf-core/modules/samtools/view/meta.yml cpan
modules/nf-core/modules/star/align/meta.yml cpan
modules/nf-core/modules/star/genomegenerate/meta.yml cpan
containers/arriba/Dockerfile docker
  • nfcore/base 1.9 build
containers/ericscript/Dockerfile docker
  • nfcore/base 1.9 build
containers/fusioncatcher/Dockerfile docker
  • ubuntu 18.04 build
containers/pizzly/Dockerfile docker
  • nfcore/base 1.9 build
containers/squid/Dockerfile docker
  • nfcore/base 1.9 build
containers/arriba/environment.yml pypi
containers/ericscript/environment.yml pypi
containers/pizzly/environment.yml pypi
containers/squid/environment.yml pypi