Training Materials

This repo contains the source for the R materials deployed on GitHub Pages.

Editing the Materials

NEVER edit the 'main' branch directly. Always create a new branch by forking the 'main' branch and work on changes there.

1. Make your updates to the qmd files
2. Render/serve the book locally
3. Generate the course script
4. Commit and push changes

Updating the Qmd files

The training materials are compiled as a Quarto book document. Everything is now triggered from _quarto.yml.

Note that exercise solutions are provided within the qmd files, but they are not included in the published bookdown (echo=FALSE). In order to update the solutions in the course script (full_script.R) you must update these hidden code chunks.

Local rendering

Perhaps obvious, but always check that your changes don't break anything and that the book runs locally. To render the book locally, run the following command in the terminal:

Quarto Render

Generating the course script

The course script is contained in full_script.R. This file must NEVER BE UPDATED MANUALLY. To update the course script, run Create_full_script.R:

source("create_full_script.R", echo=TRUE)