workshops

This repo contains tutorial materials for machine learning with tidymodels.

Organization

This repo is organized into directories:

• slides/ has Quarto files for the latest version of our slides.
• classwork/ contains Quarto files prepared for you to work along with the slides.
• archive/ is the location for older versions of this workshop.

Code of Conduct

Please note that the workshops project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Archiving Notes

To archive previous workshop notes:

• Make a subdirectory in archive/ called YYYY-MM-workshop-name.
• Copy the contents of slides/ into archive/YYYY-MM-workshop-name.
• Copy the contents of classwork/ into archive/YYYY-MM-workshop-name/classwork.
• Copy index.qmd into archive/YYYY-MM-workshop-name.
• In index.qmd, remove slides/ from links to slides.
• In _quarto.yml:
  • add an entry "archive/YYYY-MM-workshop-name/*qmd" under render.
  • add an entry "archive/YYYY-MM-workshop-name/classwork/*qmd" under resources.
• In archive/YYYY-MM-workshop-name/, add a _metadata.yml file with the contents

execute:
  freeze: true

• In the command line, run quarto render archive/YYYY-MM-workshop-name. This will regenerate the workshop slides under docs/archive/YYYY-MM-workshop-name.
• Check that:
  • Running quarto render didn't change any files in docs/ other than index.html, sitemap.xml, and search.json outside of docs/archive/.
  • The generated slides are added to _freeze/archive/YYYY-MM-workshop-name rather than in archive/YYYY-MM-workshop-name.
  • The generated slides work (specifically, that filepaths to figures function correctly.)
• In index.qmd, add an entry in H2 "Past workshops" like [M YYYY](archive/YYYY-MM-workshop-name/index.html) in workshop-name
• If you are adding slides other than English, update the navbar link in _quarto.yml.

Once the above changes are merged to main, make a GitHub Release noting the big-picture changes since the previous iteration of the workshop.

Posit Cloud setup

• Log into https://posit.cloud/
• Find the right Space in the left-hand sidebar and enter it
• Create project
  • From git repo: https://github.com/tidymodels/workshops.git
  • Open settings of the project
  • Info
    • Name: conf-YEAR
  • Access
    • General Access: Space members
    • Special Access: Make this project an assignment
  • Resources:
    • try 16 GB RAM, 4 CPU, 2h background execution limit
• Install packages
  • install.packages("pak")
  • Packages listed in index.qmd
  • Install rmarkdown (can click on the banner RStudio pops up when opening index.qmd)
  • Packages listed as dev_pkgs in slides/setup.R to be able to render the slides
• Check by rendering the slides
  • Are any packages missing?
  • Do we need more resources?
• Discard all changes from rendering