AF_Par {MPI}R Documentation

Alkire-Foster (AF) method in parallel mode

Description

Multidimensional Poverty Index using Alkire-Foster (AF) method computes in parallel mode.

Usage

AF_Par(df, g = NULL, w = NULL, k = 1)

Arguments

df

A poverty data frame

g

A column name will be used to divide data into groups. When the value is NULL, the entire data is not separated into groups.(default as NULL)

w

An indicator weight vectors (default as 1)

k

A poverty cut-off. If an aggregate value of indicators of a specific person is above or equal the value of k, then this person is considered to be a poor.(default as 1)

Value

returns a list of list contains

groupname

A Grouped value from column input 'g'

total

Number of population in each group

poors

Number of deprived people in each group

H

Head count ratio, the proportion of the population that is multidimensionally deprived calculated by dividing the number of poor people with the total number of people.

A

Average deprivation share among poor people, by aggregating the proportion of total deprivations each person and dividing by the total number of poor people.

M0

Multidimensional Poverty Index (MPI)

DimentionalContribution

indnames is poverty indicator vectors.diCont Dimensional contributions denotes the magnitude of each indicator impacts on MPI. UncensoredHCount Uncensored head count of indicator denotes the population that are deprived in that indicator. UncensoredHRatio Uncensored head count ratio of indicator denotes the proportion of the population deprived in that indicator.CensoredHCount Censored head count of indicator denotes the population that are multidimensionally poor and deprived in that indicator at the same time. CensoredHRatio Censored head count ratio of indicator denotes the proportion that is multidimensionally poor and deprived in that indicator at the same time.

pov_df

poverty data frame associated with each group.Cvector is a vector of total values of deprived indicators adjusted by weight of indicators. Each element in Cvector represents a total value of each individual. IsPoverty is a binary variable (1 and 0). 1 indicates that a person does not meet the threshold (poor person) and 0 indicates the opposite. Intensity, The intensity of a deprived indication among impoverished people is computed by dividing the number of deprived indicators by the total number of indicators.

Examples


# Run this function
## Not run: 
output <- MPI::AF_Par(df = MPI::examplePovertydf, g = "Region")

## End(Not run)


[Package MPI version 0.1.0 Index]