R/isReproducible.R

In reproducibleRchunks: Automated Reproducibility Checks for R Markdown Documents

#' @export
#' @title Test reproducibility of an R Markdown file
#'
#' @param filename Character. An R Markdown file to check for reproducibility
#' @param resetOptions Boolean. Should all package options be reset to defaults? TRUE by default. This avoids problems if multiple checks on multiple documents with varying options are made in a row
#' @param engine Character. Either knitr or rmarkdown, depending on what package should be used to render the document.
#' @param quiet Boolean. Suppress output when knitting the document.
#' @param \ldots Optional arguments passed down to \code{rmarkdown::render()}
#'
isReproducible <- function(filename,
                           resetOptions = TRUE,
                           engine = c("knitr","rmarkdown"),
                           quiet = TRUE,
                           ...)
{
  engine <- match.arg(engine)

  if (!file.exists(filename)) stop("File does not exist")
  if (!endsWith(tolower(filename),"rmd")) warning("Possibly not an Rmd file")

  if (resetOptions) {
    ids <- (startsWith(names(options()),"reproducibleRchunks."))
    opnames <- names(options())[ids]
    for (name in opnames)    options(structure(list(NULL), names = name))
  }

  .reset()

  if (engine == "rmarkdown") {
    rmarkdown::render(input = filename,
                    quiet = quiet,
                    runtime = "static",
                    run_pandoc = FALSE,
                    ...)
  } else if (engine == "knitr") {
    knitr::knit(input = filename, quiet=quiet)
  } else {
    stop("Engine not implemented")
  }

  if (nrow(get_reproducibility_summary()) == 0) {
    message("No reproducibility information found! Could not evaluate reproducibility status.")
    return(NA)
  }

  return(all(get_reproducibility_summary()$Success))

}