Skip to contents

Set the geobounds cache directory

Source: R/gb-cache.R
gb_set_cache_dir.Rd

Sets the active cache directory and optionally saves it for future sessions. Use gb_detect_cache_dir() to find the active cache directory.

Usage

gb_set_cache_dir(cache_dir, overwrite = FALSE, install = FALSE, quiet = FALSE)

Arguments

cache_dir

A path to a cache directory. If missing, the function stores cache files in a temporary directory. See base::tempdir().

overwrite

Logical. If TRUE, replace a cache directory already saved in the configuration file.

install

Logical. If TRUE, save the cache directory for use in future sessions. Defaults to FALSE. If cache_dir is missing or empty, this parameter is set to FALSE automatically.

quiet

Logical. If TRUE, suppress informational messages.

Value

An invisible character vector containing the path to the cache directory.

Details

By default, when no cache_dir is set, the package uses a directory inside base::tempdir(). Files in this directory are removed when the R session ends. To reuse a cache directory across R sessions, use gb_set_cache_dir(cache_dir = "a/path/here", install = TRUE). This saves the directory in a configuration file under tools::R_user_dir("geobounds", "config").

Cache strategies

  • For occasional use, use the default temporary cache directory.

  • Set the cache directory for the current session with gb_set_cache_dir(cache_dir = "a/path/here").

  • Save a persistent cache directory for future R sessions with gb_set_cache_dir(cache_dir = "a/path/here", install = TRUE).

  • Set the cache directory for an individual download with the cache_dir argument. See gb_get().

See also

tools::R_user_dir().

Cache utilities: gb_clear_cache(), gb_detect_cache_dir()

Examples


# Caution: this may modify your current state.

# \dontrun{
my_cache <- gb_detect_cache_dir()
#> ℹ /tmp/Rtmp5V6c4X/geobounds

# Set an example cache.
ex <- file.path(tempdir(), "example", "cachenew")
gb_set_cache_dir(ex)
#> ✔ geobounds cache directory is /tmp/Rtmp5V6c4X/example/cachenew.
#> ℹ To use this cache directory in future sessions, run this function with `install = TRUE`.

gb_detect_cache_dir()
#> ℹ /tmp/Rtmp5V6c4X/example/cachenew
#> [1] "/tmp/Rtmp5V6c4X/example/cachenew"

# Restore the initial cache.
gb_set_cache_dir(my_cache)
#> ✔ geobounds cache directory is /tmp/Rtmp5V6c4X/geobounds.
#> ℹ To use this cache directory in future sessions, run this function with `install = TRUE`.
identical(my_cache, gb_detect_cache_dir())
#> ℹ /tmp/Rtmp5V6c4X/geobounds
#> [1] TRUE
# }

gb_detect_cache_dir()
#> ℹ /tmp/Rtmp5V6c4X/geobounds
#> [1] "/tmp/Rtmp5V6c4X/geobounds"