cache_setup: Setup cache path

View source: R/cache_setup.R

cache_setupR Documentation

Setup cache path

Description

Setup cache path

Usage

cache_setup(full_path = NULL, temp_dir = FALSE)

cache_info()

Arguments

full_path

(character) the full path to use for storing cached files.

temp_dir

(logical) if TRUE use a randomly assigned tempdir (and full_path is ignored), if FALSE, you can use full_path.

Details

On opening, by default a temporary directory is created for caching files. To have files cached elsewhere, give the full path of where to cache files. Adding temp_dir = TRUE will again use a temporary dirctory for cacheing.

Value

the full cache path, a directory (character)

See Also

Other cache: cache_delete(), cache_details(), cache_list()

Examples

## Not run: 
# default path
cache_setup()

# you can define your own path
cache_setup(path = "foobar")

# set a tempdir - better for programming with to avoid prompt
cache_setup(temp_dir = TRUE)

# cache info
cache_info()

## End(Not run)

ropensci/rerddap documentation built on Jan. 25, 2024, 6:36 p.m.