add_gls_to_env: Add gls list to the global envirnment. To be used in zzz.R in...

In PIP-Technical-Team/pipload: Loads PIP data into memory

Add gls list to the global envirnment. To be used in zzz.R in other packages

Description

if you don't the official value in Sys.getenv("PIP_ROOT_DIR") you can provide the object root_dir <- "<you directory>" before executing the first function. In this way, object gls, which is a promise, will be created using with you root_dir. Otherwise, you can specify the complete directory path for each function.

Usage

add_gls_to_env(
  root_dir = NULL,
  out_dir = NULL,
  vintage = "latest",
  suffix = NULL,
  clean = FALSE
)

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.

Value

TRUE

PIP-Technical-Team/pipload documentation built on March 22, 2022, 3:22 a.m.