get_ppi: Get a household's poverty probability based on their Poverty...

Description Usage Arguments Value Examples

View source: R/01-get_ppi.R

Description

Get a household's poverty probability based on their Poverty Probability Index (PPI) score. This function uses PPI lookup tables for 60 countries available via the ppitables package.

Usage

1
get_ppi(index, ppiTable)

Arguments

index

The household's PPI score

ppiTable

Name of country PPI table to use from the ppitables package

Value

A vector of household's poverty probabilities based on various poverty metrics

Examples

1
2
3
4
# Apply function on a household in Bangladesh (BGD) with a PPI score of 65
#\dontrun{
get_ppi(index = 65, ppiTable = ppitables::ppiBGD2013)
#}

ernestguevarra/ppicalc documentation built on Jan. 14, 2020, 2:49 a.m.