Skip to contents

Loads PIP release into .pipenv

setup_working_release.Rd

This functions sets all the necessary information into the .pipenv environment to be used by other PIP packages. It does not create releases.

Usage

setup_working_release(
  release = NULL,
  identity = getOption("pipfun.identities"),
  force = FALSE,
  owner = getOption("pipfun.ghowner"),
  repo = "pip_info",
  file_path = "releases.csv",
  branch = "releases",
  verbose = getOption("pipfun.verbose"),
  ppp = getOption("pipfun.ppps"),
  creds = NULL,
  ...
)

Arguments

release

character: date in the form "%Y%m%d"

identity

character: one of "PROD", "INT", or "TEST"

owner

character: owner of repo

repo

character: repository name

file_path

character: file path

branch

character: branch where the file is

verbose

logical: whether to display additional information

ppp

numeric: PPP year to use.

creds

list. Basically, it is get_github_creds()

...

Arguments passed on to pip_create_globals

root_dir

character: root directory of the PIP data

out_dir

character: Output Directory. Default is root_dir

clean

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

max_year_country

numeric: Max year for country lineup. Default NULL, which is a heuristics that depends on the date this function is executed.

max_year_aggregate

numeric: Max year for regional nowcast.Default NULL, which is the current year

max_year_lineup

numeric: Max year for regional lineup.Default NULL, which is two years before the current year

Value

invisible table with release information and list object in the .pipenv environment

Examples

if (FALSE) { # \dontrun{
# latest PROD release
setup_working_release()

# error if set up again
try(setup_working_release())
} # }