Editing the materials

Prerequisites

• Install R and Rstudio, see the Introduction to R instructions on how to do this.
• Install Quarto. You can either run install.packages("quarto") in Rstudio, or download and install Quarto from the Quarto website.
• Install and configure git and GitHub. See the instructions for the Reproducible Code workshop how to do this.
• Editing rights to this GitHub repository.

Editing the materials

If you want to edit the book:

1. Clone the repository to your local device.
2. Create a new branch (in the command line: git checkout -b new-branch-name)
3. Make your edits. This can be in:

• The course materials, i.e. the exercises in .Rmd files which participants work in during the workshop. Important: If you make a change in the exercises, you need to also make that same change in the slides!
• The slides. These are located in the book/slides folder and are Quarto slides (.qmd). There is a file for the morning session slides and a file for the afternoon session on tidyverse.
• The book chapters, such as the schedule, the pages that embed the slides, or the What's next page. These are quarto files (.qmd) in the book folder.

4. If you want to preview the changes, you can execute quarto preview book in the terminal, or alternatively click Render in RStudio.
5. If you're happy with your edits, stage (git add file-to-stage) and commit them (`git commit -m "describe your edits here").
6. Push the edits to GitHub (git push origin new-branch-name) or click the Push button in Rstudio.
7. Create a Pull Request in the GitHub repository to merge new-branch-name with the main branch. Describe which changes were made in the PR description!
8. If you have the rights to do so, merge the PR, or have a colleague review the PR and merge it.

After merging the changes with the main branch, the GitHub Actions workflows will generate the HTML version of the materials and host them on https://utrechtuniversity.github.io/workshop-introduction-to-R-and-data/.