catrnav_clear_cache: Clear your 'CatastRoNav' cache dir

View source: R/cache_clear.R

catrnav_clear_cacheR Documentation

Clear your CatastRoNav cache dir

Description

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

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

  • Deletes the cache_dir directory.

  • Deletes the values on stored on Sys.getenv("CATASTRONAV_CACHE_DIR").

Usage

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

Arguments

config

if TRUE, will delete the configuration folder of CatastRoNav.

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 CatastRoNav.

Value

Invisible. This function is called for its side effects.

See Also

Other cache utilities: catrnav_set_cache_dir()

Examples


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

## End(Not run)

Sys.getenv("CATASTRONAV_CACHE_DIR")

rOpenSpain/CatastRoNav documentation built on April 17, 2025, 3:13 a.m.