dot-setCacheLocation: Unexported functions Set the location for the _'biomaRt'_...

.setCacheLocationR Documentation

Unexported functions Set the location for the biomaRt cache

Description

.setBiomaRtCacheLocation() attempts to set the cache location used by the functions in the biomaRt package and defined in the BIOMART_CACHE environment variable. If that variable is set and the defined location exists and is writable nothing is done. If the system default cache location exists and is writable a sub-folder app is used (and created if necessary). If the above don't work a new path is constructed from cache.dir and the app folder and an attempt is made to create that. If all of the above fail the function attempts to create file.path(tempdir(), app). If tat fails, too, an exception is thrown.

Usage

.setCacheLocation(cache.dir = rappdirs::user_cache_dir(), app = "biomaRt")

Arguments

cache.dir

(character). Optional user-defined path used as cache parent directory. Defaults to rappdirs::user_cache_dir(). If a custom path is given that has to exist.

app

(character). Optional application-specific cache sub-directory, i.e., the actually used cache location. Defaults to "biomaRt".

Value

The value of the BIOMART_CACHE environment variable, i.e., the cache location.

See Also

user_cache_dir, BiocFileCache

Examples

## Not run: .setCacheLocation()

convertid documentation built on April 4, 2025, 1:01 a.m.