TODO: Very brief intro, motivation, and overview of workshop.
This repository contains the lesson, lecture, and assignment material for the workshop, including the website source files and other associated workshop administration files.
For more detail on the workshop, check out the welcome page.
The lectures and lessons in this workshop are designed to be presented primarily with a participatory live-coding approach. This involves an instructor typing and running code in RStudio in front of the class, while the class follows along using their own computers. Challenges are interspersed in the lesson material, allowing participants to collaboratively work on smaller coding problems for a few minutes. All lesson materials are provided ahead of time on the workshop website for participants to refer to during lectures.
The teaching material is found mainly in these locations:
index.Rmd: Contains the overview of the workshop.preamble/folder: Contains the files necessary for use before the workshop, for instance the syllabus, schedule, and pre-workshop tasks.sessions/folder: Contains the files used during the workshop (e.g. code-along material)appendix/folder: Contains the files used to support the workshop, such as pre-workshop tasks, code of conduct, resources, and instructions for instructors.slides/: The lecture slides are rendered into HTML slides from Markdown.
The website is generated from Quarto, so it follows the file and folder structure conventions from that package.
If you are interested in contributing to the workshop material, please refer to the contributing guidelines. For guidelines on how to be a helper or instructor, check out the For Instructors page.
Please note that the project is released with a Contributor Code of Conduct. By contributing to or being involved in this project, you agree to abide by its terms.
The workshop is largely designed to be taught in the order given, as each session builds off of the previous ones. The easiest way to use this material is to use it as-is, making use of the tips and instructions found throughout this page. The only thing you might want to make as your own would be the slides, however, they are also good enough to use on their own too.
But if you want to customize a bit more, the best approach is to fork the repository into your own GitLab account and modify it to fit your needs from there. The website is built automatically with GitHub Actions and then published as a website through Netlify. More detail on how to build your own website from the material is outside the scope of this document but you can find more information on Quarto's Publishing page.
To help with general admin tasks of running the workshop, there is the r3admin R package. For details of the license and acknowledgement of content used from sources, see the license page of the website.
Please cite the material as:
TODO: Update
Or as BibTeX:
TODO: Update