pip_load_all_aux: Load all auxiliary files in memory
In PIP-Technical-Team/pipload: Loads PIP data into memory

pip_load_all_aux

R Documentation

Load all auxiliary files in memory

Description

Load all auxiliary files in memory

Usage

pip_load_all_aux(
  replace = NULL,
  aux = c("cpi", "ppp", "pfw", "pop", "gdm"),
  aux_names = aux,
  envir = globalenv(),
  root_dir = Sys.getenv("PIP_ROOT_DIR"),
  maindir = pip_create_globals(root_dir)$PIP_DATA_DIR,
  version = NULL,
  file_to_load = NULL,
  apply_label = TRUE,
  verbose = FALSE,
  preferred_format = NULL
)

Arguments

`replace`	logical or NULL. Whether to replace objects in `envir`
`aux`	character: auxiliary files to load. Default is c("cpi", "ppp", "pfw", "pop", "gdm", "gdp", "pce"). If "all", all auxiliary frame will be loaded in memory
`aux_names`	character of the same length of `aux`. Names of objects to be loaded. default is `aux`
`envir`	environment where the data frame will be allocated. Default is `globalenv()`
`root_dir`	character: root directory of the PIP data
`maindir`	character: main directory. By default it uses `pip_create_globals(root_dir)$PIP_DATA_DIR`
`version`	An integer or a quoted directive. "available": displays list of available versions for `measure`. "select"\|"pick"\|"choose": allows user to select the vintage of `measure`. if the integer is a zero or a negative number (e.g., `-1`), `pip_load_aux` will load that number of versions before the most recent version available. So, if `0`, it loads the current version. If `-1`, it will load the version before the current, `-2` loads two versions before the current one, and so on. If it is a positive number, it must be quoted (as character) and in the form "%Y%m%d%H%M%S".
`file_to_load`	character: file path to load. Does not work with any other argument
`apply_label`	logical: if TRUE, predefined labels will apply to data loaded using `file_to_load` argument. Default TRUE. Tip: change to FALSE if the main structure of data has changed and labels have not been updated
`verbose`	logical: whether to display message. Default is TRUE
`preferred_format`	character: preferred format. default is "fst".