https://github.com/fontikar/diy_rpkg_pkgdown
Workshop materials for implementing your {pkgdown} for your R package 📦👩💻
https://github.com/fontikar/diy_rpkg_pkgdown
pkgdown r r-package rpackage
Last synced: 8 months ago
JSON representation
Workshop materials for implementing your {pkgdown} for your R package 📦👩💻
- Host: GitHub
- URL: https://github.com/fontikar/diy_rpkg_pkgdown
- Owner: fontikar
- License: cc0-1.0
- Created: 2022-10-07T00:01:58.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-11T10:11:08.000Z (over 3 years ago)
- Last Synced: 2024-01-27T18:33:26.457Z (over 2 years ago)
- Topics: pkgdown, r, r-package, rpackage
- Homepage: https://fontikar.github.io/DIY_Rpkg_pkgdown/
- Size: 6.53 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DIY R package workshop - Part 3
Workshop materials for implementing your {pkgdown} for your R package 📦👩💻
### Hello! Welcome! 👋
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](https://jennybc.github.io/2014-05-12-ubc/ubc-r/session03_git.html) *recommended
- Completed the first part of [this workshop series](https://github.com/fontikar/DIY_Rpkg)
- Completed the second part of [this workshop series](https://github.com/fontikar/DIY_Rpkg_GHA)
- 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/
### Overview of workshop:
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 🗂
### Additional resources
If you want to give your package something *extra*:
- [Badges](https://github.com/GuangchuangYu/badger) in your README
- [Hexsticker](https://github.com/GuangchuangYu/hexSticker) in your README and to print 😍