R/build_vignettes.R

In CausalQueries: Make, Update, and Query Binary Causal Models

#' vignettes: a character vector of names of the vignettes you wish to
#'  build. Please write the vignette name without any file extension i.e.
#'  instead of "vignette_name.Rmd" please specify "vignette_name".
#'  When updating an existing vignette simply call `build_vignettes()`
#'  When writing a new vignette add your vignette name as an optional argument
#'  to the function call i.e. `build_vignettes("vignette-name")` and ensure
#'  to add the new vignette name as a default in the vignettes argument
#'
#' @keywords internal
#' @noRd

build_vignettes <- function(vignettes = c("a-getting-started",
                                          "b-plotting",
                                          "c-canonical-models",
                                          "d-front-door",
                                          "e-posteriors"), ...) {
  call <- match.call()

  # use the default vignettes argument and append user-provided ones if necessary
  if ("vignettes" %in% names(call)) {
    vignettes <- c(eval(formals()$vignettes), eval(call$vignettes))
  }

  vignettes <- unique(vignettes)

  old_wd <- getwd()

  setwd("vignettes/")

  for (v in vignettes) {
    knitr::knit(paste(v, ".Rmd.orig", sep = ""), output = paste(v, ".Rmd", sep = ""))
    knitr::purl(paste(v, ".Rmd.orig", sep = ""), output = paste(v, ".R", sep = ""))
  }

  setwd(old_wd)
}