Skip to contents

Returns the directory where downloaded CSV/ZIP artifacts are cached. The default is the user-level cache slot from tools::R_user_dir(), which can be overridden by setting the option cvmdata.cache_dir (see cvm_cache_set_path()).

Usage

cvm_cache_path()

Value

A character scalar with the absolute path.

Details

Cached artifacts are revalidated against the CVM portal (HEAD with ETag/Last-Modified) only after the freshness window expires. The window is controlled by the option cvmdata.cache_ttl_seconds (default 2592000, i.e. 30 days); set it to 0 to revalidate on every call, or to Inf to skip revalidation entirely until cvm_cache_clear() is called.

The cache size is bounded by options(cvmdata.cache_max_size_mb) (default 100 MiB). Whenever the total counted across yearly bundles and non-partitioned {artifact, sidecar} pairs exceeds 90% of the limit, the next download evicts the oldest units (by ZIP/CSV mtime) until the cache is at or below 80% of the limit. Set the option to 0, a negative number, or Inf to disable eviction. Interactive sessions see a cvmdata_warn_eviction warning after each eviction round; batch jobs stay silent unless options(cvmdata.cache_warn_evictions = TRUE) is set.

Read-only: this function does not create the directory.

Examples

cvm_cache_path()
#> [1] "/home/runner/.cache/R/cvmdata"