-
Notifications
You must be signed in to change notification settings - Fork 3
Home
Tim Whiteaker edited this page Nov 14, 2018
·
3 revisions
These instructions show how to build ingestr on Windows. The basic procedure is to set up an RStudio project for ingestr, make sure build tools are configured, and build.
- File > New Project. Browse to existing directory, e.g., ingestr, and click Create Project.
- In Build tab, click More > Configure Build Tools.
- Uncheck Use devtools package functions if available.
- Check Generate documentation with Roxygen. Click OK.
- Install RTools if you don't already have it installed. (Download from https://cran.r-project.org/bin/windows/Rtools/)
- Click Install and Restart. You may have to install some prerequisites, e.g.,
install.packages(c("units", "readr", "rvest", "tidyr", "XML"))
- Click Install and Restart.
After that, library(ingestr)
should execute without errors.
We use pkgdown to build out the docs folder. Before running build_site
, make sure you have installed these packages or softwares:
- pandoc (to handle YAML metadata in vignettes)
- magick (to generate the favicon from logo.png) -
install.packages("magick")
When you are ready to build the documentation, run pkgdown::build_site()
.