Package Development Workshop (Day 2) - Package Documentation
Details
We are thrilled to kick off our 2022 programming by welcoming Joyce Robbins to lead us through a two-day interactive package development workshop! This second hour-long module will guide participants through types of and tools for package documentation. It builds upon material from “Package Development Day 1 - Your First Package” (see Meetup event https://www.meetup.com/rladies-newyork/events/283033216/), however participants can join this second session independently. Besides familiarity with R/RStudio and basic function writing, there are no prerequisites.
RSVP for this workshop is via Google Form: https://forms.gle/3rkuU8CZDMBrudfK8/.
Course materials are available here: https://github.com/jtr13/pkgdev/. Please note the “Pre-workshop setup” instructions for Windows and Mac.
Agenda for Day 2 (tentative):
Noon-1 pm: Lesson
- devtools::check(): checking a package
- Naming your package
- Licensing your package
- Adding dependencies
- Adding examples to documentation
- Creating vignettes
- Using git/GitHub
- Where next?
1-1:30 pm: Lab with Joyce and teaching assistants Erin Grand and Emily Dodwell
