R package development with GitHub Pages and pkgdown
Details
Creating clear, professional documentation is key to making your R package useful to other people, but building a documentation website can be tricky. The `pkgdown` package makes this process much easier, but deploying via GitHub Pages can present its own set of challenges.
In this workshop, we’ll build a simple R package together, and use GitHub Actions and GitHub Pages to create a `pkgdown` documentation website for the package. By the end of this workshop, you’ll have:
- 🌎 A toy R package available on GitHub for others to install
- 📄 A `pkgdown` website for your package, deployed via GitHub Pages
Before the workshop participants should:
- Create a GitHub account. Note that prior experience with package development and/or GitHub is not required.
- Download and install R, Positron, and Git on their personal PCs.
- If you have trouble with the above we are able to provide access to the Posit Cloud environment as a backup.
At the workshop participants should:
- Bring your own PC.
- Be willing to learn and contribute to a safe and welcoming environment.
This is an in-person event with limited space! Please only RSVP if you are able to attend in-person!
***Please note that the mission of R-Ladies is to increase gender diversity in the R community. This event is intended to provide a safe space for women and gender minorities. We ask for male allies to be invited by and accompanied by a woman or gender minority.***