Skip to content
Branch: master
Clone or download
Latest commit 6b5d9fc May 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R custom learners May 24, 2019
bookdown custom learners May 24, 2019
man docs Apr 29, 2019
.Rbuildignore custom learners May 24, 2019
.editorconfig wrap package around book Mar 5, 2019
.gitignore ... Mar 26, 2019
.ignore deploy Apr 10, 2019
.travis.yml fqdn May 5, 2019
DESCRIPTION add GGally May 15, 2019
LICENSE wrap package around book Mar 5, 2019
NAMESPACE ... Mar 26, 2019
README.md Update README.md May 15, 2019
serve custom learners May 24, 2019

README.md

mlr3book

Travis build status

Package to build the mlr3 bookdown book. The rendered book can be found here.

To install all necessary dependencies for the book, install the this package using remotes:

remotes::install_github("mlr-org/mlr3book", dependencies = TRUE)

To build the book, run the following command in the repository root:

pkgload::load_all()
serve_mlr3book()

This starts a service which automatically (re-)compiles the bookdown sources in the background.

Style Guide

Chunk Names

  • Chunks should be named [chapter-name]-id, where id is some short description of what is happening.

Links and References

  • The package mlr3book provides the helpers cran_pkg(), mlr_pkg(), gh_pkg(), and ref()

Blocks

  • Blocks for notes, warnings, ... TODO
You can’t perform that action at this time.