Skip to content

Commit

Permalink
update README with DOI and add CITATION.cff
Browse files Browse the repository at this point in the history
  • Loading branch information
sreichl committed Feb 21, 2024
1 parent c3c24e2 commit 8299a6b
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 3 deletions.
40 changes: 40 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: >-
Single-cell RNA sequencing (scRNA-seq) Differential
Expression Analysis & Visualization Workflow
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Stephan
family-names: Reichl
orcid: 'https://orcid.org/0000-0001-8555-7198'
affiliation: CeMM Research Center for Molecular Medicine
- given-names: Christoph
family-names: Bock
orcid: 'https://orcid.org/0000-0001-6091-3088'
affiliation: CeMM Research Center for Molecular Medicine
identifiers:
- type: doi
value: 10.5281/zenodo.10689139
description: >-
This DOI represents all versions, and will always
resolve to the latest one.
repository-code: 'https://github.com/epigen/dea_seurat/'
url: 'https://epigen.github.io/dea_seurat/'
abstract: >-
A Snakemake workflow for performing differential
expression analyses (DEA) on (multimodal) scRNA-seq data
powered by the R package Seurat.
keywords:
- scRNA-seq
- Differential Expression Analysis
- Visualization
- Bioinformatics
- Workflow
- Snakemake
license: MIT
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
[![DOI](https://zenodo.org/badge/483638364.svg)](https://zenodo.org/doi/10.5281/zenodo.10689139)

# Single-cell RNA sequencing (scRNA-seq) Differential Expression Analysis & Visualization Snakemake Workflow
A [Snakemake](https://snakemake.readthedocs.io/en/stable/) workflow for performing differential expression analyses (DEA) of processed (multimodal) scRNA-seq data powered by the R package [Seurat's](https://satijalab.org/seurat/index.html) functions [FindMarkers](https://satijalab.org/seurat/reference/findmarkers) and [FindAllMarkers](https://satijalab.org/seurat/reference/findallmarkers).

This workflow adheres to the module specifications of [MR.PARETO](https://github.com/epigen/mr.pareto), an effort to augment research by modularizing (biomedical) data science. For more details, instructions and modules check out the project's repository. Please consider starring and sharing modules that are useful to you, this helps me in prioritizing my efforts!

**If you use this workflow in a publication, don't forget to give credits to the authors by citing the URL of this (original) repository (and its DOI, see Zenodo badge above -> coming soon).**

**If you use this workflow in a publication, please don't forget to give credits to the authors by citing it using this DOI [10.5281/zenodo.XXXX]().**
**If you use this workflow in a publication, please don't forget to give credits to the authors by citing it using this DOI [10.5281/zenodo.10689139](https://zenodo.org/doi/10.5281/zenodo.10689139).**

![Workflow Rulegraph](./workflow/dags/rulegraph.svg)

Expand Down Expand Up @@ -50,7 +52,7 @@ The outlined analyses were performed using the R package Seurat (ver) [ref] unle
To visually summarize results of the same analysis the filtered log2(fold change) values of features that were found to be at least in one comparison statistically significantly differentially expressed were visualized in a hierarchically clustered heatmap using pheatmap (ver) [ref].
Volcano plots were generated for each analysis using EnhancedVolcano (ver) [ref] with adjusted p-value threshold of [X] and log2(fold change) threshold of [X] as visual cut-offs for the y- and x-axis, respectively.

**The analysis and visualizations described here were performed using a publicly available Snakemake [ver] (ref) workflow [ref - cite this workflow here].**
**The analysis and visualizations described here were performed using a publicly available Snakemake [ver] (ref) workflow [[10.5281/zenodo.10689139](https://zenodo.org/doi/10.5281/zenodo.10689139)].**

# Features
The workflow performs the following steps to produce the outlined results (`dea_seurat/{analysis}/`).
Expand Down Expand Up @@ -110,7 +112,7 @@ We provide metadata, annotation and configuration files for this data set in ./t
# Links
- [GitHub Repository](https://github.com/epigen/dea_seurat/)
- [GitHub Page](https://epigen.github.io/dea_seurat/)
- [Zenodo Repository (coming soon)]()
- [Zenodo Repository](https://zenodo.org/doi/10.5281/zenodo.10689139)
- [Snakemake Workflow Catalog Entry](https://snakemake.github.io/snakemake-workflow-catalog?usage=epigen/dea_seurat)

# Resources
Expand Down

0 comments on commit 8299a6b

Please sign in to comment.