pip_load_data: Load PIP microdata in different way

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

Load PIP microdata in different way

Description

This function was deprecated because DLW data will loaded directly from a flat folder structure which allows bypassing the use of datalibweb in Stata, making the pipdp Stata package useless.From now on, use the dlw functions: pip_load_dlw_inventory, pip_find_dlw, and pip_load_dlw.

Usage

pip_load_data(
  country = NULL,
  year = NULL,
  survey_acronym = NULL,
  vermast = NULL,
  veralt = NULL,
  module = NULL,
  tool = c("PC", "TB"),
  source = NULL,
  survey_id = NULL,
  condition = NULL,
  type = "dataframe",
  root_dir = Sys.getenv("PIP_ROOT_DIR"),
  maindir = pip_create_globals(root_dir)$PIP_DATA_DIR,
  inv_file = fs::path(maindir, "_inventory/inventory.fst"),
  filter_to_pc = TRUE,
  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: combination of tool and source separated by a hyphen (e.g., PC-GPWG)
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
source	character: Source of data. It could be GPWG, HIST, GROUP, synth, BIN, and ALL. The latter is used only in Table Maker.
survey_id	character: Vector with survey IDs like 'HND_2017_EPHPM_V01_M_V01_A_PIP_PC-GPWG'
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_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.
type	character: Either dataframe or list. Defaults is dataframe.
root_dir	character: root directory of the PIP data
maindir	character: Main directory
inv_file	character: file path to be loaded.
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.table

Examples

# ONe year and one country
df <- pip_load_data(country = "PRY",
              year    = 2017)

# specific years for one country
df <- pip_load_data(
            country = "PRY",
            year = c(2010, 2012)
)

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

# Load a different module (e.g., GPWG)
df <- pip_load_data(country = "PRY",
             year = 2010,
             module = "PC-GPWG")

# Load different sources
df <- pip_load_data(country = "COL",
             source = "HIST")

# Load using Survey ID
df <- pip_load_data(survey_id = c("HND_2017_EPHPM_V01_M_V02_A_PIP_PC-GPWG",
                            "HND_2018_EPHPM_V01_M_V02_A_PIP_PC-GPWG")
                            )
# Use condition argument
df <- pip_find_data(condition = "country_code %chin% c('PRY', 'KGZ') &
                    (surveyid_year >= 2012 & surveyid_year < 2014)")

## Not run: 
# more than two years for more than one country (only firt year will be used)
pip_load_data(
       country = c("PRY", "ARG"),
       year = c(2010, 2012)
)

# all countries and years
pip_load_data()

## End(Not run)

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