Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mskcc/forte
Functional Observation of RNA Transcriptome Elements/Expression
https://github.com/mskcc/forte
Last synced: about 1 month ago
JSON representation
Functional Observation of RNA Transcriptome Elements/Expression
- Host: GitHub
- URL: https://github.com/mskcc/forte
- Owner: mskcc
- License: mit
- Created: 2022-12-13T16:13:15.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T21:16:28.000Z (about 2 months ago)
- Last Synced: 2024-11-06T22:22:59.283Z (about 2 months ago)
- Language: Nextflow
- Size: 21.1 MB
- Stars: 7
- Watchers: 14
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATIONS.md
Awesome Lists containing this project
README
# FORTE
## Introduction
**mskcc/forte** is a best-practice analysis pipeline for bulk RNAseq.
- **F**unctional
- **O**bservation of
- **R**NA
- **T**ranscriptome
- **E**lements/**E**xpression
### Features
1. Read pre-processing
1. Trimming
2. UMI extraction and deduplication
2. Alignment
3. Transcript quantification
4. Fusion calling and annotation
5. FASTQ and BAM QC
6. Fillouts
## Quick Start
1. Install [`Nextflow`](https://www.nextflow.io/docs/latest/getstarted.html#installation) (`>=21.10.3`)
2. Install any of [`Docker`](https://docs.docker.com/engine/installation/), [`Singularity`](https://www.sylabs.io/guides/3.0/user-guide/) (you can follow [this tutorial](https://singularity-tutorial.github.io/01-installation/)), [`Podman`](https://podman.io/), [`Shifter`](https://nersc.gitlab.io/development/shifter/how-to-use/) or [`Charliecloud`](https://hpc.github.io/charliecloud/) for full pipeline reproducibility _(you can use [`Conda`](https://conda.io/miniconda.html) both to install Nextflow itself and also to manage software within pipelines. Please only use it within pipelines as a last resort; see [docs](https://nf-co.re/usage/configuration#basic-configuration-profiles))_.
3. Clone the pipeline repository and test it on a minimal dataset with the following steps:
```bash
nextflow run /path/to/clonedrepo/main.nf -profile test,singularity --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.
## Usage
:::note
If you are new to Nextflow and nf-core, please refer to [this page](https://nf-co.re/docs/usage/installation) on how
to set-up Nextflow. Make sure to [test your setup](https://nf-co.re/docs/usage/introduction#how-to-run-a-pipeline)
with `-profile test` before running the workflow on actual data.
:::
Now, you can run the pipeline using:
```bash
nextflow run /path/to/clonedrepo/main.nf \
--input samplesheet.csv \
--outdir \
--genome GRCh37 \
-profile singularity
```
:::warning
Please provide pipeline parameters via the CLI or Nextflow `-params-file` option. Custom config files including those
provided by the `-c` Nextflow option can be used to provide any configuration _**except for parameters**_;
see [docs](https://nf-co.re/usage/configuration#custom-configuration-files).
:::
For more details and further functionality, please refer to the [usage documentation](docs/usage.md).
## Pipeline output
For more details about the output files and reports, please refer to the
[output documentation](docs/output.md).
## Credits
mskcc/forte was originally written by Anne Marie Noronha .
We thank the following people for their extensive assistance in the development of this pipeline:
- Allison Richards
- Alexandria Pinto
- Yixiao Gong
We also thank the following contributors:
- Sam Tischfield
- Martina Bradic
- Jun Woo
- Mark Donoghue
- Helen Won
## Contributions and Support
If you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md).
## Citations
An extensive list of references for the tools used by the pipeline can be found in the [`CITATIONS.md`](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](https://dx.doi.org/10.1038/s41587-020-0439-x).