bulkrna

Dalmolin Group's workflow for pre-processing, alignment and quantification of bulk RNA-seq data

https://github.com/dalmolingroup/bulkrna

Science Score: 57.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
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 7 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.8%) to scientific vocabulary

Keywords

bioinformatics bulk-rna-seq expression nextflow pipeline
Last synced: 6 months ago · JSON representation ·

Repository

Dalmolin Group's workflow for pre-processing, alignment and quantification of bulk RNA-seq data

Basic Info
Statistics
  • Stars: 8
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 2
Topics
bioinformatics bulk-rna-seq expression nextflow pipeline
Created about 3 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Citation

README.md

Nextflow run with conda run with docker run with singularity

BulkRNA logo

Introduction

dalmolingroup/bulkrna is an analysis pipeline for pre-processing, alignment and quantification of bulk RNA-Seq data.

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!

Pipeline summary

  1. Read QC (FastQC)
  2. Read trimming (fastp)
  3. Alignment and quantification (kallisto)
  4. Import quantifications into a count matrix, at gene and transcript level(tximport)
  5. Present QC for trimmed reads and alignment (MultiQC)

Quick Start

  1. Install Nextflow (>=22.10.1)

  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:

bash nextflow run dalmolingroup/bulkrna -profile test,YOURPROFILE --outdir <OUTDIR>

For example, run the test with Docker:

bash nextflow run dalmolingroup/bulkrna -profile test,docker --outdir bulkrna_results

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!

bash nextflow run dalmolingroup/bulkrna --input samplesheet.csv --outdir <OUTDIR> --transcriptome <PATH TO TRANSCRIPTOME FASTA> --gtf <PATH TO GTF FILE> -profile <docker/singularity/podman/shifter/charliecloud/conda/institute>

References

To acquire reference transcriptome and GTF files to use in your execution, we recommend using the Ensembl database.

Credits

dalmolingroup/bulkrna was originally written by João Cavalcante.

Contributions and Support

If you would like to contribute to this pipeline, please see the contributing guidelines.

Citations

An extensive list of references for the tools used by the pipeline can be found in the CITATIONS.md file.

This pipeline uses code and infrastructure developed and maintained by the nf-core community, reused here under the MIT license.

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: Dalmolin Systems Biology Group
  • Login: dalmolingroup
  • Kind: organization
  • Location: Natal, RN - Brazil

Research group in Systems Biology at UFRN

Citation (CITATION.cff)

cff-version: 1.0.2
message: "If you use this workflow, please cite it as below."
authors:
  - family-names: "Cavalcante"
    given-names: "João Vitor"
    orcid: "https://orcid.org/0000-0001-7513-7376"
  - family-names: "Siqueira Dalmolin"
    given-names: "Rodrigo Juliani"
    orcid: "https://orcid.org/0000-0002-1688-6155"
title: "dalmolingroup/bulkrna"
url: "https://github.com/dalmolingroup/bulkrna"

GitHub Events

Total
  • Watch event: 2
  • Fork event: 1
Last Year
  • Watch event: 2
  • Fork event: 1

Dependencies

.github/workflows/branch.yml actions
  • mshick/add-pr-comment v1 composite
.github/workflows/ci.yml actions
  • actions/checkout v2 composite
  • nf-core/setup-nextflow v1 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
  • mshick/add-pr-comment v1 composite
  • nf-core/setup-nextflow v1 composite
  • psf/black stable composite
.github/workflows/linting_comment.yml actions
  • dawidd6/action-download-artifact v2 composite
  • marocchino/sticky-pull-request-comment v2 composite
modules/nf-core/custom/dumpsoftwareversions/meta.yml cpan
modules/nf-core/fastp/meta.yml cpan
modules/nf-core/fastqc/meta.yml cpan
modules/nf-core/kallisto/index/meta.yml cpan
modules/nf-core/multiqc/meta.yml cpan
pyproject.toml pypi