Workshop materials for implementing your {pkgdown} for your R package ๐ฆ๐ฉโ๐ป
For this interactive workshop, we will be creating a website for your R package together ๐
Participants should have the following ready for the workshop
- The most recent version of R (โฅ 4.1) and RStudio (โฅ1.4) installed
- The following package(s) and their dependencies installed: devtools, testthat, knitr
- The most recent version of git installed
- Have a Github account
- Basic usage of git *recommended
- Completed the first part of this workshop series
- Completed the second part of this workshop series
- Basic understanding of a yaml file *optional!
For the workshop, we will be working from main_functions.Rmd
This file is also neatly rendered here so its easier to read and to copy and paste code: https://fontikar.github.io/DIY_Rpkg_pkgdown/
Interactive coding:
- The best things come as {pkgdown} pages ๐
- Storage is a little different ๐ -Set & forget it with GitHub Actions โฒ
- Updating your package documentation ๐
- Got Articles? ๐
- Customising your website โจ๐จ
- Nifty Navbars ๐บ
- Ordering your Articles menu ๐
- Ordering your Reference Section ๐
If you want to give your package something extra:
- Badges in your README
- Hexsticker in your README and to print ๐