Introduction ✨

What the course will look like

We will work together through developing a package, and at various steps along the way we will take detours to examine tools, processes, and package structure.

The tools we’ll be using (RStudio + devtools, usethis, and friends) are designed to ‘get out of the way’ and enable a workflow that helps you focus on the code you are writing. We’ll be live coding together, and emphasizing these workflows and processes.

The core ideas in this course are taken from the R Packages book (Wickham and Bryan 2023) by Hadley Wickham and Jenny Bryan, now in its second edition. We basically follow the format of the “Whole Game” chapter, stepping through the key steps in making a package, with detours along the way to explore the main concepts in a bit more detail.

About this website

This site is meant to be supplemental to the in-class activities. The slides are available in pdf form. The modules contain the code that we wrote in the workshop, with very little explanation or annotation. This is intentional - for a self-guided walk-through of package development, I recommend reading the R Packages book.

Course logistics

Code of Conduct

Please note that all participants must abide by the Code of Conduct. We are committed to providing a professional, friendly and safe environment for all participants at its events, regardless of gender, sexual orientation, disability, race, ethnicity, religion, national origin or other protected class.

Schedule (All times PST)

Topic Duration
2024-11-04
08:00 - 09:20 What is a Package? Package Structure and State 80 min
09:20 - 09:35 Break 15 min
09:35 - 10:55 Package Creation and Metadata 80 min
10:55 - 11:10 Break 15 min
11:10 - 12:30 Documentation 80 min
2024-11-05
08:00 - 09:20 Testing & Dependencies 80 min
09:20 - 09:35 Break 15 min
09:35 - 10:55 Continuous Integration & Design Principles 80 min
10:55 - 11:10 Break 15 min
11:10 - 12:30 Design Principles 80 min
2024-11-06
08:00 - 09:20 Website Creation & Using the Tidyverse in Your Package 80 min
09:20 - 09:35 Break 15 min
09:35 - 10:55 Using the Tidyverse in Your Package part 2 80 min
10:55 - 11:10 Break 15 min
11:10 - 12:30 Communicating with your Users & Distribution & General Discussion 80 min

References

Wickham, Hadley, and Jennifer Bryan. 2023. R Packages. 2nd ed. O’Reilly Media, Inc.