📦 Repo 📖 Book 🐳 Docker

README from microbiome/OMA-extras

Orchestrating Microbiome Analysis Book — extras

Overview

This is a reference cookbook for performing Microbiome Analysis with Bioconductor in R. This book is based on Quarto and BiocBook (https://www.bioconductor.org/packages/release/bioc/html/BiocBook.html).

Funding

This project received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 952914 (FindingPheno).

Deployment

The book release version is automatically built and deployed from the devel branch to the gh-pages branch using GitHub Actions.

You can also preview it locally after cloning this Github repository. This is useful if you want to suggest improvements to the material. You can also use this to test the build before making a pull request to add your new changes to the official release.

Building and viewing the book locally involves the following steps:

1. Install the necessary dependencies to build to book:

BiocManager::install(remotes::local_package_deps(dependencies=TRUE))
devtools::install('.')

2. Render and view the book:

BiocBook::preview(BiocBook::BiocBook('.'))

Code of conduct

Please note that the OMA project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.