Skip to content

Commit

Permalink
Update docs (#6)
Browse files Browse the repository at this point in the history
* add CITATION

* add missing Rd file

* add Docker CI status badge

* add scdrake citation to README
  • Loading branch information
gorgitko authored Oct 6, 2023
1 parent 67cb04b commit c06532f
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 2 deletions.
8 changes: 7 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ knitr::opts_chunk$set(
[![Pipeline diagram](https://img.shields.io/badge/Pipeline%20diagram-Show-informational)](https://github.com/bioinfocz/scdrake/blob/main/diagrams/README.md)
![License](https://img.shields.io/github/license/bioinfocz/scdrake)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check-bioc](https://github.com/bioinfocz/scdrake/actions/workflows/check-bioc.yaml/badge.svg?branch=main)](https://github.com/bioinfocz/scdrake/actions/workflows/check-bioc.yaml)
[![Docker Image CI](https://github.com/bioinfocz/scdrake/actions/workflows/docker-ci.yml/badge.svg?branch=main)](https://github.com/bioinfocz/scdrake/actions/workflows/docker-ci.yml)

`{scdrake}` is a scalable and reproducible pipeline for secondary analysis of droplet-based single-cell RNA-seq data.
`{scdrake}` is an R package built on top of the `{drake}` package, a [Make](https://www.gnu.org/software/make)-like pipeline
Expand Down Expand Up @@ -58,6 +58,12 @@ The pipeline structure along with [diagrams](https://github.com/bioinfocz/scdrak
and links to outputs is described in `vignette("pipeline_overview")`
([link](https://bioinfocz.github.io/scdrake/articles/pipeline_overview.html)).

If you use `{scdrake}` in your research, please, consider citing

> Kubovciak J, Kolar M, Novotny J (2023).
“Scdrake: a reproducible and scalable pipeline for scRNA-seq data analysis.” *Bioinformatics Advances*, **3**(1).
[doi:10.1093/bioadv/vbad089](https://doi.org/10.1093/bioadv/vbad089).

Huge thanks go to the authors of the
[Orchestrating Single-Cell Analysis with Bioconductor](https://bioconductor.org/books/3.15/OSCA) book on whose
methods and recommendations is `{scdrake}` largely based.
Expand Down
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ diagram](https://img.shields.io/badge/Pipeline%20diagram-Show-informational)](ht
![License](https://img.shields.io/github/license/bioinfocz/scdrake)
[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check-bioc](https://github.com/bioinfocz/scdrake/actions/workflows/check-bioc.yaml/badge.svg?branch=main)](https://github.com/bioinfocz/scdrake/actions/workflows/check-bioc.yaml)
[![Docker Image
CI](https://github.com/bioinfocz/scdrake/actions/workflows/docker-ci.yml/badge.svg?branch=main)](https://github.com/bioinfocz/scdrake/actions/workflows/docker-ci.yml)

`{scdrake}` is a scalable and reproducible pipeline for secondary
analysis of droplet-based single-cell RNA-seq data. `{scdrake}` is an R
Expand Down Expand Up @@ -63,6 +64,13 @@ The pipeline structure along with
and links to outputs is described in `vignette("pipeline_overview")`
([link](https://bioinfocz.github.io/scdrake/articles/pipeline_overview.html)).

If you use `{scdrake}` in your research, please, consider citing

> Kubovciak J, Kolar M, Novotny J (2023). “Scdrake: a reproducible and
> scalable pipeline for scRNA-seq data analysis.” *Bioinformatics
> Advances*, **3**(1).
> [doi:10.1093/bioadv/vbad089](https://doi.org/10.1093/bioadv/vbad089).
Huge thanks go to the authors of the [Orchestrating Single-Cell Analysis
with Bioconductor](https://bioconductor.org/books/3.15/OSCA) book on
whose methods and recommendations is `{scdrake}` largely based.
Expand Down
11 changes: 11 additions & 0 deletions inst/CITATION
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
bibentry(
"Article",
title = "Scdrake: a reproducible and scalable pipeline for scRNA-seq data analysis",
author = as.person(c("Jan Kubovciak", "Michal Kolar", "Jiri Novotny")),
editor = "Guoqiang Yu",
year = 2023,
journal = "Bioinformatics Advances",
volume = 3,
number = 1,
doi = "10.1093/bioadv/vbad089"
)
16 changes: 16 additions & 0 deletions man/reexports.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c06532f

Please sign in to comment.