https://github.com/ltla/csawbook
The book of the package.
https://github.com/ltla/csawbook
Last synced: 3 months ago
JSON representation
The book of the package.
- Host: GitHub
- URL: https://github.com/ltla/csawbook
- Owner: LTLA
- Created: 2020-11-08T05:12:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-17T20:03:20.000Z (about 2 years ago)
- Last Synced: 2025-04-05T04:26:03.786Z (about 1 year ago)
- Language: TeX
- Size: 129 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# The csaw book
This repository contains a Bioconductor package to deploy the **csaw** user guide as a **bookdown** book.
Install all relevant packages used in the book with:
```r
BiocManager::install(remotes::local_package_deps(dependencies=TRUE))
```
Building the book can be done by either running the usual **bookdown** invocation in `inst/book`:
```r
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:
```r
rebook::updateDependencies("inst/book", path='DESCRIPTION')
rebook::configureBook()
```