SHARK4R (version 1.0.2)

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 = tools::R_user_dir("SHARK4R", "cache"),
  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 SHARK4R cache directory in the user-specific R folder (via tools::R_user_dir("SHARK4R", "cache")). You can override this parameter for custom cache locations.

clear_perm_cache

Logical. If TRUE, filed 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 after 24h.

See Also

get_peg_list(), get_nomp_list(), get_shark_codes(), get_dyntaxa_dwca(), get_shark_statistics() for functions that populate the cache.

Examples

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