Skip to content
Irena Papst edited this page Sep 28, 2023 · 1 revision

Welcome to the EPACmodel wiki!

Build package site

To build the package site,

  1. Set the working directory to the main package directory and launch an R session
  2. Re-install EPACmodel with devtools::install()
    • The pkg-models vignette builds from each package models' README file, which is stored in inst; changes to files in inst won't be caught unless the package is re-installed.
  3. Build README.md by knitting README.Rmd with rmarkdown::render("README.Rmd")
  4. Build the site locally using pkgdown::build_site() to check that site builds properly
  5. Push/pull request changes into the main branch; GitHub Actions has a workflow configured to automatically build and deploy the site when main is updated.
Clone this wiki locally