OSCA-source / OSCA

The package wrapping the book, for deployment via the Bioconductor build system.
https://bioconductor.org/checkResults/devel/books-LATEST/OSCA
76 stars 19 forks source link

OSCA book, overview

This repository contains a Bioconductor package to deploy the landing subbook of the Orchestrating Single-Cell Analysis book. Install all relevant packages used in the book with:

BiocManager::install(remotes::local_package_deps(dependencies=TRUE))

Building the book can be done by either running the usual bookdown invocation in inst/book:

bookdown::render_book("index.Rmd")

Or by R CMD build on the package itself to compile the book during the vignette build process.

To contribute reports, follow standard procedure: fork and PR. This requires updating of files in inst/rebook to support links from external packages. The updates are usually handled by the GitHub Action but can be done manually with:

rebook::updateDependencies("inst/book", path='DESCRIPTION')
rebook::configureBook(redirect='redirect.txt')

BBS Build reports

Build reports are available from: