Skip to content

Home

Jump to bottom
Dorien Huijser edited this page Apr 29, 2025 · 4 revisions

Welcome to the workshop-introduction-to-R-and-data wiki!

This repository contains the workshop materials for the workshop Introduction to R and Data, provided by Utrecht University. The workshop materials are created using Quarto (which creates HTML files) and hosted with GitHub pages on https://utrechtuniversity.github.io/workshop-introduction-to-R-and-data/.

Repository structure

  • .github/workflows folder contains 2 GitHub action workflows (see below)
  • book folder contains the Quarto book that creates the workshop materials
  • course-materials folder contains the course materials for participants
  • .gitignore lists which files, folders and file extensions should not be tracked by git or uploaded to GitHub
  • CITATION.cff contains basic metadata to cite the repository
  • LICENSE contains the license of the repository materials
  • README.md is the README of the repository
  • course-materials.zip is a zipped version of the course-materials folder that the participants download to their computer to learn R during the workshop
  • workshop.Rproj is an R project file that can be opened in Rstudio when working on the repository

The book structure

The Quarto book consists of several files:

  • _quarto.yml is the configuration file, specifying metadata, styling and the order of the chapters, among others
  • many .qmd files which are the chapters of the book
  • slides in the slides folder, which are by themselves quarto files and are rendered to HTML and then embedded in the relevant book chapters
  • images and videos used in the book

Workflows in the repository

The GitHub repository is set up in such a way that when an edit is made to the content (such as a .qmd or .Rmd file), the book is automatically rendered. This makes it possible to edit content directly on GitHub instead of having to clone the repository to your local PC (although it is recommended to clone to a local PC since that allows previewing your changes).

There are 2 github action workflows in the .github/workflows folder:

  • 1 that automatically renders the workshop materials into HTML (publish.yml) whenever a change is made to a file in the book folder.
  • 1 that creates a zip file from the course materials folder that the course participants can then download (zip-workshop-materials.yml) whenever a change is made to a file in the course-materials folder

Additionally to these GitHub actions: whenever the book is rendered as part of the publish.yml workflow, first the script render-slides.R in the folder book/pre-rendering is run. This script renders the slides in the folder book/slides to create html slides. After this is done, the book as a whole is rendered, so that the newest version of the slides is embedded in the book.

Clone this wiki locally