Skip to contents

Create global variables for PIP data management

Usage

pip_create_globals(
  root_dir = Sys.getenv("PIP_ROOT_DIR"),
  out_dir = root_dir,
  vintage = "latest",
  suffix = NULL,
  clean = FALSE,
  verbose = getOption("pipload.verbose")
)

Arguments

root_dir

character: root directory of the PIP data

out_dir

character: Output Directory. Default is root_dir

vintage

character: name of output folder. It could be "latest", "new", or any other name. if it is "latest" (default), the most recent version available in the vintage directory of the form "%Y%m%d" will be used. If it is "new", a new folder with a name of the form "%Y%m%d" will be created. All the names will be coerced to lower cases

suffix

character: suffix to be added to the name of the vintage folder. Useful for testing purposes. Something of the form "%Y%m%d_test" won't be taken into account if the vintage = "latest"

clean

logical: if TRUE it cleans all empty directories that have been created by mistake. Default is FALSE.

verbose

logical: display messages. Default is getOption("pipload.verbose")

Value

list

Examples

if (FALSE) {
pip_create_globals()
}