howardbaek / bookclub-rpkgs

R4DS R Packages Book Club

Welcome to the R4DS R Packages Book Club!

We are working together to read R Packages by Hadley Wickham and Jenny Bryan (work-in-progress 2nd edition, copyright 2022). Join the #book_club-rpkgs channel on the R4DS Slack to participate. As we read, we are producing notes about the book.

Meeting Schedule

If you would like to present, please see the sign-up sheet for your cohort (linked below, and pinned in the #book_club-rpkgs channel on Slack)!

• Cohort 1 (started 2020-09-29, ended 2020-12-15): meeting videos
• Cohort 2 (started 2021-03-13, ended 2021-06-05): meeting videos
• Cohort 3 (started 2022-03-30, ended 2022-08-17): meeting videos
• Cohort 4 (started 2022-10-05): Wednesdays, 20:00 CST/CDT | meeting videos

---

How to Present

This repository is structured as a {bookdown} site. To present, follow these instructions:

Do these steps once:

1. Setup Github Locally (also see Happy Git and GitHub for the useR)
2. Install {usethis} and {devtools} install.packages(c("usethis", "devtools"))
3. Set up a default {usethis} directory:

• usethis::edit_r_profile() to open your profile for editing.
• Add this line: options(usethis.destdir = "YOURDIR") (replace YOURDIR with the root directory under which you want your R projects to appear; or you can skip these steps, and the project will be saved to your Desktop).
• Restart your R session (Session/Restart R in Rstudio).

4. usethis::create_from_github("r4ds/bookclub-rpkgs") (cleanly creates your own copy of this repository).

Do these steps each time you present another chapter:

1. Open your project for this book.
2. usethis::pr_init("my-chapter") (creates a branch for your work, to avoid confusion, making sure that you have the latest changes from other contributors; replace my-chapter with a descriptive name, ideally).
3. devtools::install_dev_deps() (installs any packages used by the book that you don't already have installed).
4. Edit the appropriate chapter file, if necessary. Use ## to indicate new slides (new sections).
5. If you use any packages that are not already in the DESCRIPTION, add them. You can use usethis::use_package("myCoolPackage") to add them quickly!
6. Build the book! ctrl-shift-b (or command-shift-b) will render the full book, or ctrl-shift-k (command-shift-k) to render just your slide. Please do this to make sure it works before you push your changes up to the main repo!
7. Commit your changes (either through the command line or using Rstudio's Git tab).
8. usethis::pr_push() (pushes the changes up to github, and opens a "pull request" (PR) to let us know your work is ready).
9. (If we request changes, make them)
10. When your PR has been accepted ("merged"), usethis::pr_finish() to close out your branch and prepare your local repository for future work.
11. Now that your local copy is up-to-date with the main repo, you need to update your remote fork. Run gert::git_push("origin") or click the Push button on the Git tab of Rstudio.

When your PR is merged into the main branch, the bookdown site will rebuild, adding your slides to this site.

Images

If any static files are used in the .Rmd for a chapter, please add them into the directory ./images/<chapter_number>-<title_stub>/. For example, to include images for the "02-the-whole-game" chapter, please place them in ./images/02-the-whole-game/. Name files in a manner that is informative on what the image represents.