clean_shark4r_cache: Clean SHARK4R cache by file age and session

Description

Deletes cached files in the SHARK4R cache directory that are older than a specified number of days.

Usage

clean_shark4r_cache(
  days = 1,
  cache_dir = NULL,
  clear_perm_cache = FALSE,
  search_pattern = NULL,
  verbose = TRUE
)

Value

Invisible NULL. Messages are printed about what was deleted and whether the in-memory session cache was cleared.

Arguments

days: Numeric; remove files older than this number of days. Default is 1.
cache_dir: Character; path to the cache directory to clean. Defaults to the package cache directory in the user-specific R folder (via the internal cache_dir() helper). You can override this parameter to specify a custom cache location.
clear_perm_cache: Logical. If TRUE, files that are cached across R sessions are cleared, i.e. geographical shape files. Defaults to FALSE.
search_pattern: Character; optional regex pattern to filter which files to consider for deletion.
verbose: Logical. If TRUE, displays messages of cache cleaning progress. Defaults to TRUE.

Details

The cache is automatically cleared for files older than 24 hours. Files in the perm subdirectory are not removed automatically and must be cleared explicitly using clear_perm_cache = TRUE.

Examples

Run this code

# \donttest{
  # Remove files older than 60 days and clear session cache
  try(clean_shark4r_cache(days = 60))
# }