An open API service indexing awesome lists of open source software.

https://github.com/nf-core/dartseq

Pipeline for m6A detection in RNAseq data
https://github.com/nf-core/dartseq

dartseq nextflow nf-core pipeline rna-editing rnaseq workflow

Last synced: 6 days ago
JSON representation

Pipeline for m6A detection in RNAseq data

Awesome Lists containing this project

README

          




nf-core/dartseq

[![Open in GitHub Codespaces](https://img.shields.io/badge/Open_In_GitHub_Codespaces-black?labelColor=grey&logo=github)](https://github.com/codespaces/new/nf-core/dartseq)
[![GitHub Actions CI Status](https://github.com/nf-core/dartseq/actions/workflows/nf-test.yml/badge.svg)](https://github.com/nf-core/dartseq/actions/workflows/nf-test.yml)
[![GitHub Actions Linting Status](https://github.com/nf-core/dartseq/actions/workflows/linting.yml/badge.svg)](https://github.com/nf-core/dartseq/actions/workflows/linting.yml)[![AWS CI](https://img.shields.io/badge/CI%20tests-full%20size-FF9900?labelColor=000000&logo=Amazon%20AWS)](https://nf-co.re/dartseq/results)
[![nf-test](https://img.shields.io/badge/unit_tests-nf--test-337ab7.svg)](https://www.nf-test.com)

[![Nextflow](https://img.shields.io/badge/version-%E2%89%A525.04.0-green?style=flat&logo=nextflow&logoColor=white&color=%230DC09D&link=https%3A%2F%2Fnextflow.io)](https://www.nextflow.io/)
[![nf-core template version](https://img.shields.io/badge/nf--core_template-3.5.2-green?style=flat&logo=nfcore&logoColor=white&color=%2324B064&link=https%3A%2F%2Fnf-co.re)](https://github.com/nf-core/tools/releases/tag/3.5.2)
[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.XXXXXXX.svg)](https://doi.org/10.5281/zenodo.XXXXXXX)
[![run with conda](http://img.shields.io/badge/run%20with-conda-3EB049?labelColor=000000&logo=anaconda)](https://docs.conda.io/en/latest/)
[![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?labelColor=000000&logo=docker)](https://www.docker.com/)
[![run with singularity](https://img.shields.io/badge/run%20with-singularity-1d355c.svg?labelColor=000000)](https://sylabs.io/docs/)
[![Launch on Seqera Platform](https://img.shields.io/badge/Launch%20%F0%9F%9A%80-Seqera%20Platform-%234256e7)](https://cloud.seqera.io/launch?pipeline=https://github.com/nf-core/dartseq)

[![Get help on Slack](http://img.shields.io/badge/slack-nf--core%20%23dartseq-4A154B?labelColor=000000&logo=slack)](https://nfcore.slack.com/channels/dartseq)[![Follow on Bluesky](https://img.shields.io/badge/bluesky-%40nf__core-1185fe?labelColor=000000&logo=bluesky)](https://bsky.app/profile/nf-co.re)[![Follow on Mastodon](https://img.shields.io/badge/mastodon-nf__core-6364ff?labelColor=FFFFFF&logo=mastodon)](https://mstdn.science/@nf_core)[![Watch on YouTube](http://img.shields.io/badge/youtube-nf--core-FF0000?labelColor=000000&logo=youtube)](https://www.youtube.com/c/nf-core)

## Introduction

**nf-core/dartseq** is a workflow for DART-seq style RNA sequencing analyses with optional RNA editing downstream steps.
It accepts single-end or paired-end FASTQ input, performs read QC and alignment, and can run Bullseye- and RustQC-based
post-processing. Standard outputs include per-sample QC reports, alignments, MultiQC summaries, and optional edited-site tables.

![nf-core/dartseq workflow overview](docs/images/dartseq_metromap.png)

Workflow overview:

1. Parse and validate the input samplesheet.
2. Trim reads with `fastp` or `Trim Galore` (or skip trimming if requested).
3. Run per-sample quality control with [FastQC](https://www.bioinformatics.babraham.ac.uk/projects/fastqc/).
4. Build or use provided aligner references (STAR or HISAT2).
5. Align reads and produce sorted BAM files plus index files.
6. Run optional Bullseye editing analysis:
parse BAM, summarize sites, quantify edits, compare against controls, and optionally RAC filter / gather sites / GLM.
7. Run optional RustQC summaries on alignments.
8. Aggregate run-wide summaries and software versions with [MultiQC](http://multiqc.info/).

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

Prepare a samplesheet with at least `sample`, `fastq_1`, and `fastq_2` columns.
For single-end data, leave `fastq_2` empty.

Now, you can run the pipeline using:

```bash
nextflow run nf-core/dartseq \
-profile \
--input samplesheet.csv \
--outdir
```

> [!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/docs/usage/getting_started/configuration#custom-configuration-files).

For more details and further functionality, please refer to the [usage documentation](https://nf-co.re/dartseq/usage) and the [parameter documentation](https://nf-co.re/dartseq/parameters).

## Pipeline output

To see the results of an example test run with a full size dataset refer to the [results](https://nf-co.re/dartseq/results) tab on the nf-core website pipeline page.
For more details about the output files and reports, please refer to the
[output documentation](https://nf-co.re/dartseq/output).

## Credits

nf-core/dartseq was originally written by Mathieu Flamand, Olga Brovkina, Joana Pimenta Bernardes, Fatemeh Nasehi.

We thank the following people for their extensive assistance in the development of this pipeline:

- The nf-core maintainers and community contributors who helped evolve the template integration and testing strategy.

## Contributions and Support

If you would like to contribute to this pipeline, please see the [contributing guidelines](.github/CONTRIBUTING.md).

For further information or help, don't hesitate to get in touch on the [Slack `#dartseq` channel](https://nfcore.slack.com/channels/dartseq) (you can join with [this invite](https://nf-co.re/join/slack)).

## Citations

If this pipeline is used in a publication, cite the nf-core framework below and the software references in `CITATIONS.md`.
After the first release, update the placeholder DOI `10.5281/zenodo.XXXXXXX` in this README with the pipeline Zenodo DOI.

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