Skip to content

Home

Jump to bottom
Tim Whiteaker edited this page Nov 14, 2018 · 3 revisions

Welcome to the ingestr wiki!

Getting ingestr working in RStudio on Windows

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.

  1. File > New Project. Browse to existing directory, e.g., ingestr, and click Create Project.
  2. In Build tab, click More > Configure Build Tools.
  3. Uncheck Use devtools package functions if available.
  4. Check Generate documentation with Roxygen. Click OK.
  5. Install RTools if you don't already have it installed. (Download from https://cran.r-project.org/bin/windows/Rtools/)
  6. Click Install and Restart. You may have to install some prerequisites, e.g., install.packages(c("units", "readr", "rvest", "tidyr", "XML"))
  7. Click Install and Restart.

After that, library(ingestr) should execute without errors.

Building HTML documentation

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().

Clone this wiki locally