R/knit_briefing.R

In djpr-data/djprlabourdash: DJSIR Jobs Dashboard

#' @title Create a Word document containing briefing tables
#' @description This function knits a briefing document that uses tables generated in this
#' package to create a Word document. It knits the RMarkdown file
#' `jobs_briefing.Rmd` that lives in the `inst` folder of `djprlabourdash`.
#' @param path Path to directory where
#' the knitted Word document should be created.
#' @param quietly Passed to `rmarkdown::render()`'s `quiet` argument. `FALSE` by
#' default.
#' @param show Show knitted document when done?
#' @examples
#' \dontrun{
#' knit_briefing(quietly = TRUE)
#' }
#' @export
knit_briefing <- function(path = here::here("inst"),
                          quietly = FALSE,
                          show = TRUE) {

  # stopifnot(grepl('djprlabourdash', rstudioapi::getActiveProject())) #crashes tests

  if (!requireNamespace("rmarkdown", quietly = TRUE)) {
    stop(
      "knit_briefing() requires the rmarkdown package.\n",
      " Install it with: install.packages('rmarkdown')"
    )
  }

  if (!requireNamespace("officedown", quietly = TRUE)) {
    stop(
      "knit_briefing() requires the officedown package.\n",
      " Install it with: install.packages('officedown')"
    )
  }

  reports <- c("jobs_briefing.Rmd",
               "jobs_headline.Rmd")

  for (rmd in reports){
    filename <- paste0("DJSIR_",
                       tools::file_path_sans_ext(rmd),
                       "_", Sys.Date(), ".docx")

    out_path <- file.path(path, filename)
    rmd_path <- system.file(rmd, package = "djprlabourdash")

    rmarkdown::render(
      input = rmd_path,
      output_file = out_path,
      quiet = quietly
    )

    if (show) { # TODO: shell.exec does not work on rstudio server
      normalizePath(out_path) %>%
        shell.exec()
    }


  }

  return(out_path)
}