rnaseq

RNA sequencing analysis pipeline using STAR, RSEM, HISAT2 or Salmon with gene/isoform counts and extensive quality control.

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

Science Score: 49.0%

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

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 10 DOI reference(s) in README
  • Academic publication links
  • Committers with academic emails
    17 of 97 committers (17.5%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (10.6%) to scientific vocabulary

Keywords

nextflow nf-core pipeline rna rna-seq workflow

Keywords from Contributors

bioinformatics metagenomics pipelines workflows illumina nanopore long-read-sequencing assembly smrna-seq small-rna
Last synced: 6 months ago · JSON representation

Repository

RNA sequencing analysis pipeline using STAR, RSEM, HISAT2 or Salmon with gene/isoform counts and extensive quality control.

Basic Info
  • Host: GitHub
  • Owner: nf-core
  • License: mit
  • Language: Nextflow
  • Default Branch: master
  • Homepage: https://nf-co.re/rnaseq
  • Size: 72.5 MB
Statistics
  • Stars: 1,087
  • Watchers: 173
  • Forks: 789
  • Open Issues: 71
  • Releases: 37
Topics
nextflow nf-core pipeline rna rna-seq workflow
Created almost 8 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

nf-core/rnaseq

GitHub Actions CI Status GitHub Actions Linting StatusAWS CICite with Zenodo nf-test

Nextflow nf-core template version run with conda run with docker run with singularity Launch on Seqera Platform

Get help on SlackFollow on BlueskyFollow on MastodonWatch on YouTube

Introduction

nf-core/rnaseq is a bioinformatics pipeline that can be used to analyse RNA sequencing data obtained from organisms with a reference genome and annotation. It takes a samplesheet and FASTQ files as input, performs quality control (QC), trimming and (pseudo-)alignment, and produces a gene expression matrix and extensive QC report.

nf-core/rnaseq metro map

In case the image above is not loading, please have a look at the static version.

  1. Merge re-sequenced FastQ files (cat)
  2. Auto-infer strandedness by subsampling and pseudoalignment (fq, Salmon)
  3. Read QC (FastQC)
  4. UMI extraction (UMI-tools)
  5. Adapter and quality trimming (Trim Galore!)
  6. Removal of genome contaminants (BBSplit)
  7. Removal of ribosomal RNA (SortMeRNA)
  8. Choice of multiple alignment and quantification routes (For STAR the sentieon implementation can be chosen):
    1. STAR -> Salmon
    2. STAR -> RSEM
    3. HiSAT2 -> NO QUANTIFICATION
  9. Sort and index alignments (SAMtools)
  10. UMI-based deduplication (UMI-tools)
  11. Duplicate read marking (picard MarkDuplicates)
  12. Transcript assembly and quantification (StringTie)
  13. Create bigWig coverage files (BEDTools, bedGraphToBigWig)
  14. Extensive quality control:
    1. RSeQC
    2. Qualimap
    3. dupRadar
    4. Preseq
    5. DESeq2
    6. Kraken2 -> Bracken on unaligned sequences; optional
  15. Pseudoalignment and quantification (Salmon or 'Kallisto'; optional)
  16. Present QC for raw read, alignment, gene biotype, sample similarity, and strand-specificity checks (MultiQC, R)

Note The SRA download functionality has been removed from the pipeline (>=3.2) and ported to an independent workflow called nf-core/fetchngs. You can provide --nf_core_pipeline rnaseq when running nf-core/fetchngs to download and auto-create a samplesheet containing publicly available samples that can be accepted directly as input by this pipeline.

Warning Quantification isn't performed if using --aligner hisat2 due to the lack of an appropriate option to calculate accurate expression estimates from HISAT2 derived genomic alignments. However, you can use this route if you have a preference for the alignment, QC and other types of downstream analysis compatible with the output of HISAT2.

Usage

[!NOTE] If you are new to Nextflow and nf-core, please refer to this page on how to set-up Nextflow. Make sure to test your setup with -profile test before running the workflow on actual data.

First, prepare a samplesheet with your input data that looks as follows:

samplesheet.csv:

csv sample,fastq_1,fastq_2,strandedness CONTROL_REP1,AEG588A1_S1_L002_R1_001.fastq.gz,AEG588A1_S1_L002_R2_001.fastq.gz,auto CONTROL_REP1,AEG588A1_S1_L003_R1_001.fastq.gz,AEG588A1_S1_L003_R2_001.fastq.gz,auto CONTROL_REP1,AEG588A1_S1_L004_R1_001.fastq.gz,AEG588A1_S1_L004_R2_001.fastq.gz,auto

Each row represents a fastq file (single-end) or a pair of fastq files (paired end). Rows with the same sample identifier are considered technical replicates and merged automatically. The strandedness refers to the library preparation and will be automatically inferred if set to auto.

[!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.

Now, you can run the pipeline using:

bash nextflow run nf-core/rnaseq \ --input <SAMPLESHEET> \ --outdir <OUTDIR> \ --gtf <GTF> \ --fasta <GENOME FASTA> \ -profile <docker/singularity/.../institute>

For more details and further functionality, please refer to the usage documentation and the parameter documentation.

Pipeline output

To see the results of an example test run with a full size dataset refer to the results tab on the nf-core website pipeline page. For more details about the output files and reports, please refer to the output documentation.

This pipeline quantifies RNA-sequenced reads relative to genes/transcripts in the genome and normalizes the resulting data. It does not compare the samples statistically in order to assign significance in the form of FDR or P-values. For downstream analyses, the output files from this pipeline can be analysed directly in statistical environments like R, Julia or via the nf-core/differentialabundance pipeline.

Online videos

A short talk about the history, current status and functionality on offer in this pipeline was given by Harshil Patel (@drpatelh) on 8th February 2022 as part of the nf-core/bytesize series.

You can find numerous talks on the nf-core events page from various topics including writing pipelines/modules in Nextflow DSL2, using nf-core tooling, running nf-core pipelines as well as more generic content like contributing to Github. Please check them out!

Credits

These scripts were originally written for use at the National Genomics Infrastructure, part of SciLifeLab in Stockholm, Sweden, by Phil Ewels (@ewels) and Rickard Hammarén (@Hammarn).

The pipeline was re-written in Nextflow DSL2 and is primarily maintained by Harshil Patel (@drpatelh) from Seqera Labs, Spain.

The pipeline workflow diagram was initially designed by Sarah Guinchard (@G-Sarah) and James Fellows Yates (@jfy133), further modifications where made by Harshil Patel (@drpatelh) and Maxime Garcia (@maxulysse).

Many thanks to other who have helped out along the way too, including (but not limited to):

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 #rnaseq channel (you can join with this invite).

Citations

If you use nf-core/rnaseq for your analysis, please cite it using the following doi: 10.5281/zenodo.1400710

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: nf-core
  • Login: nf-core
  • Kind: organization
  • Email: core@nf-co.re

A community effort to collect a curated set of analysis pipelines built using Nextflow.

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 3,329
  • Total Committers: 97
  • Avg Commits per committer: 34.32
  • Development Distribution Score (DDS): 0.645
Past Year
  • Commits: 293
  • Committers: 27
  • Avg Commits per committer: 10.852
  • Development Distribution Score (DDS): 0.481
Top Committers
Name Email Commits
drpatelh d****l@g****m 1,183
Harshil Patel d****h@g****m 438
Phil Ewels p****s@s****e 434
Rickard Hammarén r****n@s****e 185
Olga Botvinnik o****k@g****m 172
Alexander Peltzer a****r@g****m 131
Gregor Sturm m****l@g****e 66
Harshil Patel d****h@u****m 63
Alexander Peltzer a****r@u****e 60
Alexander Peltzer a****r@u****m 45
pranathi.vemuri p****i@g****m 43
maxulysse m****a@g****m 42
Denis Moreno d****o@s****e 38
Lorena Pantano l****o@g****m 30
nf-core-bot c****e@n****e 28
Mahesh Binzer-Panchal m****l@n****e 28
Rob Syme r****e@g****m 24
Silvia Morini s****i@q****e 20
Matthias Zepper M****r@u****m 19
Gavin Kelly g****y@c****k 18
James Fellows Yates j****3@g****m 14
FriederikeHanssen f****n@q****e 13
Lorena Pantano l****o@a****m 12
rfenouil 3****l@u****m 12
Chris Cheshire c****e@g****m 10
JoseEspinosa k****u@g****m 10
jenmuell j****r@s****e 10
Edmund Miller e****r@p****m 9
Adam Talbot a****t@s****o 8
Peng Zhou z****i@g****m 8
and 67 more...

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 299
  • Total pull requests: 396
  • Average time to close issues: 4 months
  • Average time to close pull requests: 20 days
  • Total issue authors: 197
  • Total pull request authors: 55
  • Average comments per issue: 2.4
  • Average comments per pull request: 2.23
  • Merged pull requests: 270
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 86
  • Pull requests: 105
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 2 days
  • Issue authors: 70
  • Pull request authors: 28
  • Average comments per issue: 1.47
  • Average comments per pull request: 1.3
  • Merged pull requests: 57
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • adamrtalbot (34)
  • pinin4fjords (10)
  • SuhasSrinivasan (8)
  • maxulysse (8)
  • drpatelh (7)
  • MatthiasZepper (5)
  • alexmascension (3)
  • fjosefdz (3)
  • robsyme (3)
  • ewallace (3)
  • ewels (3)
  • GerardTromp (3)
  • holmrenser (2)
  • mingmingpei001 (2)
  • edmundmiller (2)
Pull Request Authors
  • pinin4fjords (110)
  • adamrtalbot (61)
  • maxulysse (59)
  • drpatelh (57)
  • nf-core-bot (19)
  • bentsherman (13)
  • robsyme (9)
  • MatthiasZepper (7)
  • edmundmiller (6)
  • roldanjg (2)
  • FriederikeHanssen (2)
  • J-Moravec (2)
  • pmoris (2)
  • ewels (2)
  • egreenberg7 (2)
Top Labels
Issue Labels
bug (136) enhancement (107) question (21) local (11) nf-core/modules (11) awaiting-response-community (10) awaiting-response (7) first-timers-only (4) feature-request (4) Ready for review (4) awaiting-response-developers (4) needs-testing (3) documentation (2) help wanted (1) wontfix (1)
Pull Request Labels
Ready for review (14) bug (9) enhancement (3) awaiting-response-community (2) wontfix (1) feature-request (1) documentation (1)

Dependencies

.github/workflows/branch.yml actions
  • mshick/add-pr-comment v1 composite
.github/workflows/ci.yml actions
  • actions/cache v3 composite
  • actions/checkout v3 composite
  • actions/checkout v2 composite
  • nf-core/setup-nextflow v1 composite
.github/workflows/clean-up.yml actions
  • actions/stale v7 composite
.github/workflows/cloud_tests_full.yml actions
  • actions/upload-artifact v3 composite
  • seqeralabs/action-tower-launch v1 composite
.github/workflows/cloud_tests_small.yml actions
  • actions/upload-artifact v3 composite
  • seqeralabs/action-tower-launch v1 composite
.github/workflows/fix-linting.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
.github/workflows/linting.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 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/bbmap/bbsplit/meta.yml cpan
modules/nf-core/cat/fastq/meta.yml cpan
modules/nf-core/custom/dumpsoftwareversions/meta.yml cpan
modules/nf-core/custom/getchromsizes/meta.yml cpan
modules/nf-core/fastp/meta.yml cpan
modules/nf-core/fastqc/meta.yml cpan
modules/nf-core/fq/subsample/meta.yml cpan
modules/nf-core/gffread/meta.yml cpan
modules/nf-core/gunzip/meta.yml cpan
modules/nf-core/hisat2/align/meta.yml cpan
modules/nf-core/hisat2/build/meta.yml cpan
modules/nf-core/hisat2/extractsplicesites/meta.yml cpan
modules/nf-core/picard/markduplicates/meta.yml cpan
modules/nf-core/preseq/lcextrap/meta.yml cpan
modules/nf-core/rsem/calculateexpression/meta.yml cpan
modules/nf-core/rsem/preparereference/meta.yml cpan
modules/nf-core/rseqc/bamstat/meta.yml cpan
modules/nf-core/rseqc/inferexperiment/meta.yml cpan
modules/nf-core/rseqc/innerdistance/meta.yml cpan
modules/nf-core/rseqc/junctionannotation/meta.yml cpan
modules/nf-core/rseqc/junctionsaturation/meta.yml cpan
modules/nf-core/rseqc/readdistribution/meta.yml cpan
modules/nf-core/rseqc/readduplication/meta.yml cpan
modules/nf-core/rseqc/tin/meta.yml cpan
modules/nf-core/salmon/index/meta.yml cpan
modules/nf-core/salmon/quant/meta.yml cpan
modules/nf-core/samtools/flagstat/meta.yml cpan
modules/nf-core/samtools/idxstats/meta.yml cpan
modules/nf-core/samtools/index/meta.yml cpan
modules/nf-core/samtools/sort/meta.yml cpan
modules/nf-core/samtools/stats/meta.yml cpan
modules/nf-core/sortmerna/meta.yml cpan
modules/nf-core/star/align/meta.yml cpan
modules/nf-core/star/genomegenerate/meta.yml cpan
modules/nf-core/stringtie/stringtie/meta.yml cpan
modules/nf-core/subread/featurecounts/meta.yml cpan
modules/nf-core/trimgalore/meta.yml cpan
modules/nf-core/ucsc/bedclip/meta.yml cpan
modules/nf-core/ucsc/bedgraphtobigwig/meta.yml cpan
modules/nf-core/umitools/dedup/meta.yml cpan
modules/nf-core/umitools/extract/meta.yml cpan
modules/nf-core/untar/meta.yml cpan
subworkflows/nf-core/bam_dedup_stats_samtools_umitools/meta.yml cpan
subworkflows/nf-core/bam_markduplicates_picard/meta.yml cpan
subworkflows/nf-core/bam_rseqc/meta.yml cpan
subworkflows/nf-core/bam_sort_stats_samtools/meta.yml cpan
subworkflows/nf-core/bam_stats_samtools/meta.yml cpan
subworkflows/nf-core/bedgraph_bedclip_bedgraphtobigwig/meta.yml cpan
subworkflows/nf-core/fastq_align_hisat2/meta.yml cpan
subworkflows/nf-core/fastq_fastqc_umitools_fastp/meta.yml cpan
subworkflows/nf-core/fastq_fastqc_umitools_trimgalore/meta.yml cpan
subworkflows/nf-core/fastq_subsample_fq_salmon/meta.yml cpan
pyproject.toml pypi