get_poverty_vars: Calculate poverty indicators based on the Poverty Probability...

In validmeasures/wsup: An Implementation of the WSUP Urban Water and Sanitation Survey in R

Description

Calculate poverty indicators based on the Poverty Probability Index (PPI).

Usage

get_poverty_vars(surveyData, index, ccode, ppiTable)

Arguments

surveyData	A data frame containing informatiom to be used for calculating the Poverty Probability Index (PPi)
index	A numeric vector of length equal to surveyData containing data on the calculated PPI score
ccode	Three letter ISO code for a country
ppiTable	Name of country PPI table to use from the ppitables package

Value

A data frame containing calculated PPI scores, corresponding poverty probabilities and wealth quintile

Examples

ppiMatrixBGD <- washdata::ppiMatrixBGD
povertyDF <- get_poverty_vars(surveyData = washdata::surveyDataBGD, 
                              index = ppi, 
                              ccode = "BGD",
                              ppiTable = ppitables::ppiBGD2013)

validmeasures/wsup documentation built on Dec. 16, 2019, 4:50 a.m.