calculate_ppi: Function to calculate Poverty Probability Index (PPI) for...

In ernestguevarra/ppicalc: Calculator for Determining Poverty Likelihood Based on the Poverty Probability Index (PPI)

Description

Function to calculate Poverty Probability Index (PPI) for Kenya

Usage

calculate_ppi(path, ccode, category = get_poverty_class(ccode = ccode))

Arguments

path	Directory path to IPA's country-specific PPI data analysis and collection XLSX file
ccode	A character value for three letter ISO code for country to calculate PPI for. Currently, 12 countries are supported by this function: 1) Colombia (COL); 2) Ivory Coast (CIV); 3) Dominican Republic (DOM); 4) Ghana (GHA); 5) Kenya (KEN); 6) Mozambique (MOZ); 7) Myanmar (MMR); 8) Peru (PER); 9) Philippines (PHL); 10) Rwanda (RWA); 11) Senegal (SEN); 12) Togo (TGO)
category	Poverty classifications. This defaults to all the poverty classifications available for the selected country

Value

A dataframe of PPI for each household in df.

Examples

calculate_ppi(path = paste(system.file("ppi", package = "ppicalc"),
                           "colombia.xlsx", sep = "/"),
              ccode = "COL")

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