R/caching.R

In kunstler/laselva: Access to Global Forest Inventory Data

#' Manage cached files
#'
#' @export
#' @name laselva_cache
#'
#' @details `cache_delete` only accepts 1 file name, while
#' `cache_delete_all` doesn't accept any names, but deletes all files.
#' For deleting many specific files,
#' use `cache_delete` in a [lapply()] type call
#'
#' We cache using \pkg{hoardr} for managing cached files. Find where
#' files are being cached with `laselva_cache$cache_path_get`
#'
#' @section Functions:
#'
#' - `laselva_cache$list()` returns a character vector of full path file
#'  names
#' - `laselva_cache$delete()` deletes one or more files, returns nothing
#' - `laselva_cache$delete_all()` delete all files, returns nothing
#' - `laselva_cache$details()` prints file name and file size for each
#'  file, supply with one or more files, or no files (and get details for
#'  all available)
#'
#' @examples \dontrun{
#' laselva_cache
#'
#' # list files in cache
#' laselva_cache$list()
#'
#' # List info for single files
#' allfiles <- laselva_cache$list()
#' laselva_cache$details(files = allfiles[1])
#' laselva_cache$details(files = allfiles[2])
#'
#' # List info for all files
#' laselva_cache$details()
#'
#' # delete files by name in cache
#' # laselva_cache$delete(files = allfiles[1])
#' # laselva_cache$list()
#'
#' # delete all files in cache
#' # laselva_cache$delete_all()
#' # laselva_cache$list()
#' }
NULL