Skip to content

Package Development Workshop (Day 2) - Package Documentation

Photo of Emily Dodwell
Hosted By
Emily D. and Erin G.
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

Instructor Biography:
Joyce Robbins, Ph.D., is Lecturer in Discipline in the Statistics Department at Columbia University, where she specializes in data visualization. She is a member of the R Forwards (R Foundation taskforce on women and other under-represented groups) teaching team, previously served as publications officer of the Statistical Graphics Section of the American Statistical Association Section, and is an active member of RLadies NYC.

---

Many thanks to Mine Çetinkaya-Rundel and Emma Rand of the R Forwards Teaching Team for their creation of the package development workshop modules on which this session is based. For more information, see https://forwards.github.io/workshops/.

---

R-Ladies is dedicated to providing a harassment-free experience for everyone. We do not tolerate harassment of participants in any form. Please take a moment to review the R-Ladies Global code of conduct (particularly if this is your first time attending!): https://rladies.org/code-of-conduct

Photo of R-Ladies New York group
R-Ladies New York
See more events
Online event
This event has passed