R/showcache.R

In rickwargo/lrequire: Sources an R "Module" with Caching & Encapsulation, Returning Exported Vars

#' Prints the current file cache
#'
#' @param all.names a logical value. If TRUE, all object names are returned. If FALSE,
#'                  names which begin with a . are omitted.
#'
#' @return Nothing is returned, however, the contents of the module cache are printed to the standard output.
#' @export
#'
#' @examples
#' show.module.cache()
#' show.module.cache(all.names = TRUE)
show.module.cache <- function(all.names = FALSE) {
  cat("--- module cache ---\n")
  for (v in ls(module.cache, all.names = all.names)) {
    print(paste0(v, ': ', module.cache[[v]]), quote=FALSE)
  }
}