R/cache-api.R

In r-hub/crancache: Transparent Caching of Packages from CRAN-Like Repositories

#' List packages in the cache
#'
#' @return A data frames. Each data frame has four columns:
#' `Package`, `Repository`, `Version` and `MD5sum`.
#'
#' @family cache management functions
#' @export
#' @importFrom cranlike package_versions

crancache_list <- function() {
  create_cache_if_needed()
  cache_dirs <- unique_with_names(get_cache_package_dirs())
  lists <- lapply(cache_dirs, package_versions)
  res <- do.call(rbind, lists)
  res <- cbind(
    Package = res$Package,
    Repository = rep(names(cache_dirs), vapply(lists, nrow, integer(1))),
    res[, setdiff(colnames(res), "Package")]
  )
  res <- res[order(res$Package), ]
  rownames(res) <- NULL
  res
}

#' Remove the cache completely
#'
#' It deletes the cache directory as well.
#'
#' @inheritParams base::unlink
#' @family cache management functions
#' @export

crancache_clean <- function(force = FALSE) {
  create_cache_if_needed()
  cache_dir <- get_cache_dir()
  unlink(cache_dir, recursive = TRUE, force = force)
  invisible()
}

#' Remove some packages from the cache
#'
#' The function ignores errors, so if it fails to remove a
#' package, it just continues with the rest of the packages.
#'
#' @param pkgs A character vector of regular expressions, that are
#'   matched to file names in all package directories. The matching
#'   files are removed from the cache.
#'
#' @family cache management functions
#' @export
#' @importFrom cranlike remove_PACKAGES

crancache_remove <- function(pkgs) {
  create_cache_if_needed()
  cache_dirs <- get_cache_package_dirs()
  for (dir in cache_dirs) {
    files <- unlist(lapply(pkgs, list.files, path = dir))
    for (file in files) {
      if (!is_quiet()) {
        message("Removing ", sQuote(file), " from cache")
      }
      try(remove_PACKAGES(file, dir = dir))
    }
  }
  invisible()
}