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 |
|
pov_df |
poverty data frame associated with each group. |
Examples
# Run this function
## Not run:
output <- MPI::AF_Par(df = MPI::examplePovertydf, g = "Region")
## End(Not run)