Reports the active cache configuration, including the effect of any options that have been set. See the Options section below for details.

sooty_cache_info()

Value

A data frame (invisibly) with cache details.

Options

Two options control cache behaviour:

sooty.allow.cache

logical, default TRUE. Set to FALSE to skip all disk I/O and use only the bundled sysdata. Suitable for examples, tests, and offline use: options("sooty.allow.cache" = FALSE).

sooty.cache.path

path, default tools::R_user_dir("sooty", "cache"). Override the cache directory. Useful for CI or shared environments: options("sooty.cache.path" = tempdir()).

Examples

sooty_cache_info()
#> Cache directory: /home/runner/.cache/R/sooty
#>   curated catalogue:
#>     not yet written to user cache (sysdata fallback available)
#>     bundled  : 232798 rows (ships with package)

op <- options("sooty.allow.cache" = FALSE)
sooty_cache_info()
#> Cache directory: /home/runner/.cache/R/sooty
#>   cache disabled via options("sooty.allow.cache" = FALSE)
#>   bundled  : 232798 rows (ships with package)
options(op)