Repository files navigation

UC Davis DataLab

Winter 2022

• Workshop reader:https://ucdavisdatalab.github.io/workshop_git_for_teams/
• Workshop event page:https://datalab.ucdavis.edu/eventscalendar/reproducible-research-for-teams-with-github-2/

The course reader is a live webpage, hosted through GitHub, where you can enter curriculum content andpost it to a public-facing site for learners. Supplementary examples for other readings are alsoappropriate, but please refrain from using it as a space to host slides.

To make alterations to the reader:

1. Clone this repo.
2. Edit one of the existing chapter.Rmd files or create a new one. Thechapter files are at the top level of the repository. They follow the namingscheme##_topic-of-chapter.Rmd (an exception to this naming scheme isindex.Rmd, which contains the reader's index page). You should enter yourtext, links, and any supporting media directly into the file.
3. Run the scriptgen_html.R to regenerate the HTML files in thedocs/directory. You can do this in the shell with./gen_html.R or in R withsource("gen_html.R").
4. Once you have made your changes, commit and push both the files you editedand thedocs/ directory. The live web page will update accordingly.

Follow the established style and formatting conventions in chapter files,including those for linking to media on theds.lib server. On theds.libserver, the course media directory is in the public-facing portion of theDataLab website (ds.lib.ucdavis.edu).

• docs -- output HTML files
• img -- image files used in chapters
• _bookdown.yml -- bookdown settings (mostly where files are)
• _common.R -- R code to run at beginning of R session for each chapter
• gen_html.R -- R script to generate the HTML files
• index.Rmd -- index page
• _output.yml -- bookdown settings (mostly formatting)

CC BY-NC 2.0