gisco_clear_cache: Clear your 'giscoR' cache dir

View source: R/gisco_cache.R View source: R/gisco_clear_cache.R

gisco_clear_cacheR Documentation

Clear your giscoR cache dir

Description

Use this function with caution. This function would clear your cached data and configuration, specifically:

  • Deletes the giscoR config directory (rappdirs::user_config_dir("giscoR", "R")).

  • Deletes the cache_dir directory.

  • Deletes the values on stored on Sys.getenv("GISCO_CACHE_DIR") and options(gisco_cache_dir).

Usage

gisco_clear_cache(config = FALSE, cached_data = TRUE, verbose = FALSE)

Arguments

config

if TRUE, will delete the configuration folder of giscoR.

cached_data

If this is set to TRUE, it will delete your cache_dir and all its content.

verbose

Logical, displays information. Useful for debugging, default is FALSE.

Details

This is an overkill function that is intended to reset your status as it you would never have installed and/or used giscoR.

Value

Invisible. This function is called for its side effects.

See Also

rappdirs::user_config_dir()

Other cache utilities: gisco_set_cache_dir()

Examples


# Don't run this! It would modify your current state
## Not run: 
gisco_clear_cache(verbose = TRUE)

Sys.getenv("GISCO_CACHE_DIR")

# Set new cache on a temp dir
newcache <- file.path(tempdir(), "giscoR", "pkgdown")

newcache

gisco_set_cache_dir(newcache)

Sys.getenv("GISCO_CACHE_DIR")

## End(Not run)

giscoR documentation built on Sept. 11, 2024, 8:11 p.m.