hockeystick (version 0.8.5)

hockeystick_cache: Manage cached datasets

Description

Manage cached datasets

Usage

hockeystick_cache_list()
hockeystick_cache_delete(files, force = TRUE)
hockeystick_cache_delete_all(force = TRUE)
hockeystick_cache_details(files = NULL)
hockeystick_update_all()

Value

hockeystick_cache_list() returns a character vector of full path filenames in cache.

hockeystick_cache_delete() no return value, called for side effect.

hockeystick_cache_delete_all() no return value, called for side effect.

hockeystick_cache_details() returns list of filenames and sizes of cached files.

hockeystick_update_all() updates all datasets and caches them. No return value, called for side effect.

Arguments

files

(character) one or more complete file names

force

(logical) Should files be force deleted? Default: TRUE

Functions

• hockeystick_cache_list() returns a character vector of full path file names in cache

• hockeystick_cache_delete() deletes one or more files, returns nothing

• hockeystick_cache_delete_all() delete all files, returns nothing

• hockeystick_cache_details() prints file name and file size of each file, supply with one or more files, or no files (and get details for all available)

• hockeystick_update_all() updates the cache with the latest co2, temperature, sea level, and sea ice data.

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 tools::R_user_dir(), find your cache folder by executing tools::R_user_dir("hockeystick","cache")

References

Caching data sets: ROpenSci guide to persistent config and data for R packages: https://blog.r-hub.io/2020/03/12/user-preferences/

Examples

# \donttest{
# list files in cache
hockeystick_cache_list()

# List info for single files
hockeystick_cache_details(files = hockeystick_cache_list()[1])
hockeystick_cache_details(files = hockeystick_cache_list()[2])

# List info for all files
hockeystick_cache_details()

# Delete cached files by name
hockeystick_cache_delete(files = hockeystick_cache_list()[1])

# Update all hockeystick data and place in cache
hockeystick_update_all()

# Delete all cached data
hockeystick_cache_delete_all()
# }