vignettes/precompile.R

In snlab-ch/goldfish: Statistical Network Models for Dynamic Network Data

# Precompiled vignettes
# Adapted from bcgov/bcdata/vignettes/precompile.R under Apache License 2.0


# Precompile vignettes -------------------------------------------------------

precompile <- function(vignette_to_run = NULL) {
  orig_files <- file.path(
    tools::list_files_with_exts(
      dir = "vignettes",
      exts = "Rmd\\.orig",
      full.names = TRUE
    )
  )

  if (!is.null(vignette_to_run)) {
    orig_files <- orig_files[basename(orig_files) %in% vignette_to_run]

    if (rlang::is_empty(orig_files)) stop("Not a vignette!")
  }

  ## Convert *.orig to *.Rmd -------------------------------------------------
  purrr::walk(
    orig_files,
    \(x) {
      rmdFile <- tools::file_path_sans_ext(x)
      knitr::knit(x, rmdFile, envir = globalenv())
      purlFile <- paste0(tools::file_path_sans_ext(rmdFile), ".R")
      knitr::purl(x, purlFile)
    }
  )

  ## Move .png files into correct directory so they render -------------------
  images <- file.path(list.files("teaching", pattern = "plot-.+\\.png$"))
  success <- file.copy(
    from = file.path("teaching", images),
    to = file.path("vignettes/teaching/", images),
    overwrite = TRUE
  )

  ## Clean up if successful --------------------------------------------------
  if (!all(success)) {
    stop("Image files were not successfully transferred to vignettes directory")
  } else {
    unlink("teaching", recursive = TRUE)
  }
}

## Run all vignettes
precompile()


# check if the RMD files contain errors
lapply(
  file.path(
    tools::list_files_with_exts(
      dir = "vignettes",
      exts = "Rmd",
      full.names = TRUE
    )
  ),
  \(x) {
    text <- readLines(x)
    haveErrors <- grepl("Error:", text)
    if (any(haveErrors)) {
      paste(
        "Error in", x, " on line",
        paste(which(haveErrors), collapse = ", ")
      )
    }
  }
)

# render README.Rmd
rmarkdown::render(
  "README.Rmd",
  output_format = "md_document",
  envir = globalenv()
)