set_home: Set the local cache directory

View source: R/helpers.R

set_homeR Documentation

Set the local cache directory

Description

The function sets the environment variable RCZECHIA_HOME to be used as a local cache for RCzechia remote files; if unset tempdir() is used instead, with persistence for current session only.

Usage

set_home(path)

Arguments

path

path to local filesystem directory to be used as a cache; must exist and must be writable

Details

Note that when set (it is unset by default) the remote files will be cached to local file system and persist between R sessions, for good or bad.

Also note that you can set the value of RCZECHIA_HOME environment variable directly, either via a Sys.setenv() call or via your .Renviron file.

Value

TRUE for success and FALSE for failure; returned silently


jlacko/RCzechia documentation built on March 12, 2024, 5:48 p.m.