pip_find_dlw: Find surveys available for DatalibWeb

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

Find surveys available for DatalibWeb

Description

Find surveys available for DatalibWeb

Usage

pip_find_dlw(
  country = NULL,
  year = NULL,
  survey_acronym = NULL,
  vermast = NULL,
  veralt = NULL,
  module = NULL,
  tool = NULL,
  condition = NULL,
  root_dir = Sys.getenv("PIP_ROOT_DIR"),
  dlw_dir = pip_create_globals(root_dir)$DLW_RAW_DIR,
  filter_to_pc = FALSE,
  filter_to_tb = FALSE,
  verbose = getOption("pipload.verbose")
)

Arguments

country	character: vector of ISO3 country codes.
year	numeric: survey year
survey_acronym	character: Survey acronym
vermast	character: Master version in the form v## or ##
veralt	character: Alternative version in the form v## or ##
module	character: Source of data. It could be GPWG, HIST, GROUP, synth, BIN, and ALL. The latter is used only in Table Maker.
tool	character: PIP tool in which data will be used. It could be PC for Poverty Calculator or TB for Table Maker. Others will be added
condition	character: logical condition that applies to all surveys. For example, "year > 2012". Make sure the condition uses the names of the variables in pip_load_dlw_inventory(): orig, filename, country_code, year, survey_acronym, vermast, veralt, collection, module, tool, and source. Can't be used with arguments country, year, survey_acronym , vermast, veralt, module or tool.
root_dir	character: root directory of the PIP data
dlw_dir	character: Main directory
filter_to_pc	logical: If TRUE filter most recent data to be included in the Poverty Calculator. Default if FALSE
filter_to_tb	logical: If TRUE filter most recent data to be included in the Table Maker. Default if FALSE
verbose	logical: whether to display message. Default is TRUE

Value

data.frame: list of filenames to be loaded with pcn_load()

Examples

# all years for one country
pip_find_dlw(country = "ARG")

#' # all years for more than one country
pip_find_dlw(country = c("COL", "ARG"))

# specific years for one country
pip_find_dlw(
            country = "COL",
            year = c(2010, 2012)
)

# country FHF does not exist so it will be part of `fail` output (No error)
pip_find_dlw(
       country = c("ARG", "FHF"),
       year = 2010
)

# Load a different module (e.g., GPWG)
pip_find_dlw(country = "PRY",
             year = 2010,
             module = "GPWG",
             tool = "PC")

# Load different modules
pip_find_dlw(country = "COL",
             module = "HIST")
## Not run: 
# more than two years for more than one country (only firt year will be used)
pip_find_dlw(
       country = c("COL", "ARG"),
       year = c(2010, 2012)
)

# all countries and years
pip_find_dlw()

## End(Not run)

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