mlr3book

Repository to build the free, online version of Applied Machine Learning Using mlr3 in R using quarto.

Read the book

You can read the rendered version of the book in either:

To render the book yourself, follow these steps:

Clone this repository (https://github.com/mlr-org/mlr3book.git)
Install Quarto >=1.3.283 if needed
Run make serve to render the book to HTML and preview on a local server or make pdf to render to PDF (other options are available and documented in the Makefile), note we use xelatex for rendering to PDF

If you are making changes to the book please note the following:

Our style guide is provided here in the introduction
Where possible, figures in the HTML book should be svgs and figures in the PDF should be pdf. These should be included with knitr::include_graphics() or ideally with include_multi_graphics().
If you add a new package dependency to the book, please follow the following steps to update the lockfile:
- Start an R session in the book/ directory
- Activate the project with renv::activate()
- Restore the project environment with renv::restore()
- Run renv::install() to install the new package
- Update the Lockfile with renv::snapshot()
- Commit book/renv.lock with your changes and create a pull request.