Skip to content

Latest commit

 

History

History
129 lines (94 loc) · 9.34 KB

README.md

File metadata and controls

129 lines (94 loc) · 9.34 KB
Raw

nf-core/rnasplice nf-core/rnasplice

GitHub Actions CI Status GitHub Actions Linting StatusAWS CICite with Zenodo

Nextflow run with conda run with docker run with singularity Launch on Nextflow Tower

Get help on SlackFollow on TwitterFollow on MastodonWatch on YouTube

Introduction

nf-core/rnasplice is a bioinformatics pipeline for alternative splicing analysis of RNA sequencing data obtained from organisms with a reference genome and annotation.

nf-core/rnasplice metro map

  1. Merge re-sequenced FastQ files (cat)
  2. Read QC (FastQC)
  3. Adapter and quality trimming (TrimGalore)
  4. Alignment with STAR
  5. Choice of quantification depending on analysis type:
    1. STAR -> Salmon
    2. STAR -> featureCounts
    3. STAR -> HTSeq (DEXSeq count)
  6. Sort and index alignments (SAMtools)
  7. Create bigWig coverage files (BEDTools, bedGraphToBigWig)
  8. Pseudo-alignment and quantification (Salmon; optional)
  9. Summarize QC (MultiQC)
  10. Differential Exon Usage (DEU):
    1. HTSeq -> DEXSeq
    2. featureCounts -> edgeR
    3. Quantification with featureCounts or HTSeq
    4. Differential exon usage with DEXSeq or edgeR
  11. Differential Transcript Usage (DTU):
    1. Salmon -> DRIMSeq -> DEXSeq
    2. Filtering with DRIMSeq
    3. Differential transcript usage with DEXSeq
  12. Event-based splicing analysis:
    1. STAR -> rMATS
    2. Salmon -> SUPPA2

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:

sample,fastq_1,fastq_2,strandedness,condition
CONTROL_REP1,AEG588A1_S1_L002_R1_001.fastq.gz,AEG588A1_S1_L002_R2_001.fastq.gz,forward,CONTROL
CONTROL_REP1,AEG588A1_S1_L003_R1_001.fastq.gz,AEG588A1_S1_L003_R2_001.fastq.gz,forward,CONTROL
CONTROL_REP1,AEG588A1_S1_L004_R1_001.fastq.gz,AEG588A1_S1_L004_R2_001.fastq.gz,forward,CONTROL

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 should be specified by the user.

:::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:

nextflow run nf-core/rnasplice \
   --input samplesheet.csv \
   --contrasts contrastsheet.csv \
   --genome GRCh37 \
   --outdir <OUTDIR> \
   -profile <docker/singularity/.../institute>

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.

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.

Online videos

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

nf-core/rnasplice was originally written by the bioinformatics team from Zifo RnD Solutions:

We thank Harshil Patel (@drpatelh) and Seqera Labs (seqeralabs) for their assistance in the development of this pipeline.

Zifo RnD Solutions

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

Citations

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

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.