For my rEDM package, I’ve been using the pkgdown package to build a website comprising all the documentation and vignettes, for easy reference from a web browser.
The normal workflow for this is something like:
Make updates to the package. Run pkgdown::build_site() to generate the website files into a docs folder. Commit changes and upload to GitHub. Use GitHub Pages, configured to source the files from the docs folder on the master branch.
Motivation What I used to do Why use an R package? How-to Guide Requirements Tutorial Setup Workflow Bonus steps Other Readings Motivation I’ve been wondering about the best way to organize (reproducible) research projects in R for a while now. I figured this might be a good spot to write up some thoughts.
What I used to do Initially my projects would consist of just a few R files that separate out functions from a main script that calls the functions.