Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
rannick committed Mar 23, 2022
1 parent 3c1d6ea commit b6e1b3b
Show file tree
Hide file tree
Showing 12 changed files with 283 additions and 103 deletions.
1 change: 1 addition & 0 deletions CITATIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
> 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.
Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
[![GitHub Actions Linting Status](https://github.com/nf-core/rnafusion/workflows/nf-core%20linting/badge.svg)](https://github.com/nf-core/rnafusion/actions?query=workflow%3A%22nf-core+linting%22)
[![AWS CI](https://img.shields.io/badge/CI%20tests-full%20size-FF9900?labelColor=000000&logo=Amazon%20AWS)](https://nf-co.re/rnafusion/results)
[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.XXXXXXX-1073c8?labelColor=000000)](https://doi.org/10.5281/zenodo.3946477)
<!-- TODO update zenodo after release -->

[![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A521.10.3-23aa62.svg?labelColor=000000)](https://www.nextflow.io/)
[![run with conda](http://img.shields.io/badge/run%20with-conda-3EB049?labelColor=000000&logo=anaconda)](https://docs.conda.io/en/latest/)
Expand All @@ -21,6 +20,11 @@

The pipeline is built using [Nextflow](https://www.nextflow.io), 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](https://www.nextflow.io/docs/latest/dsl2.html) 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](https://github.com/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](https://github.com/suhrig/arriba) | :x: | `2.1.0` |
Expand All @@ -29,7 +33,6 @@ The pipeline is built using [Nextflow](https://www.nextflow.io), a workflow tool
| [Pizzly](https://github.com/pmelsted/pizzly) | :x: | `0.37.3` |
| [Squid](https://github.com/Kingsford-Group/squid) | :x: | `1.5` |
| [STAR-Fusion](https://github.com/STAR-Fusion/STAR-Fusion) | :white_check_mark: | `1.10.1` |
<!-- TODO fusion-report: check version after release -->

## Pipeline summary

Expand Down
2 changes: 0 additions & 2 deletions conf/modules.config
Original file line number Diff line number Diff line change
Expand Up @@ -244,5 +244,3 @@ process {
]
}
}


Loading

0 comments on commit b6e1b3b

Please sign in to comment.