Merge pull request #84 from katilingban/dev

add new country tables

NEWS.md

@@ -2,13 +2,8 @@
 
 This is the tenth CRAN release of `ppitables`. In this release, I added:
 
-* new PPI tables for Uganda using the new PPI calculation approach developed
-by the International Poverty Alliance (IPA) based on data from the Uganda
-National Panel Survey of 2020
-
-* new PPI tables for Tanzania using the new PPI calculation approach developed
-by the International Poverty Alliance (IPA) based on data from the Tanzania
-Household Budget Survey of 2017/2018
+* new PPI tables for multiple countries released during the period of 2021 to
+2023
 
 * updated `steer` data that serves as an index to the tables to include the new
 Indonesia PPI tables

R/00_benin.R

@@ -0,0 +1,141 @@
+################################################################################
+#
+#' Poverty Probability Index (PPI) lookup table for Benin
+#'
+#' @format A data frame with 7 columns and 101 rows:
+#' \describe{
+#' \item{\code{score}}{PPI score}
+#' \item{\code{nl100}}{National poverty line (100\%)}
+#' \item{\code{nl150}}{National poverty line (150\%)}
+#' \item{\code{nl200}}{National poverty line (200\%)}
+#' \item{\code{extreme}}{USAID extreme poverty}
+#' \item{\code{ppp125}}{Below $1.25 per day purchasing power parity (2005)}
+#' \item{\code{ppp250}}{Below $2.50 per day purchasing power parity (2005)}
+#' }
+#'
+#' @examples
+#'   # Access Benin PPI table
+#'   ppiBEN2012
+#'
+#'   # Given a specific PPI score (from 0 - 100), get the row of poverty
+#'   # probabilities from PPI table it corresponds to
+#'   ppiScore <- 50
+#'   ppiBEN2012[ppiBEN2012$score == ppiScore, ]
+#'
+#'   # Use subset() function to get the row of poverty probabilities corresponding
+#'   # to specific PPI score
+#'   ppiScore <- 50
+#'   subset(ppiBEN2012, score == ppiScore)
+#'
+#'   # Given a specific PPI score (from 0 - 100), get a poverty probability
+#'   # based on a specific poverty definition. In this example, the USAID
+#'   # extreme poverty definition
+#'   ppiScore <- 50
+#'   ppiBEN2012[ppiBEN2012$score == ppiScore, "nl100"]
+#'
+#' @source \url{https://www.povertyindex.org}
+#'
+#
+################################################################################
+"ppiBEN2012"
+
+
+
+################################################################################
+#
+#' Poverty Probability Index (PPI) lookup table for Benin for 2022 for 11
+#' questions score card
+#'
+#' @format A data frame with 14 columns and 101 rows:
+#' \describe{
+#' \item{\code{score}}{PPI score}
+#' \item{\code{nl100}}{National poverty line (100\%)}
+#' \item{\code{nl150}}{National poverty line (150\%)}
+#' \item{\code{nl200}}{National poverty line (200\%)}
+#' \item{\code{ppp190}}{Below $1.90 per day purchasing power parity (2011)}
+#' \item{\code{ppp320}}{Below $3.20 per day purchasing power parity (2011)}
+#' \item{\code{ppp550}}{Below $5.50 per day purchasing power parity (2011)}
+#' \item{\code{ppp215}}{Below $2.15 per day purchasing power parity (2017)}
+#' \item{\code{ppp365}}{Below $3.65 per day purchasing power parity (2017)}
+#' \item{\code{ppp685}}{Below $6.85 per day purchasing power parity (2017)}
+#' \item{\code{percentile20}}{Below 20th percentile poverty line}
+#' \item{\code{percentile40}}{Below 40th percentile poverty line}
+#' \item{\code{percentile60}}{Below 60th percentile poverty line}
+#' \item{\code{percentile80}}{Below 80th percentile poverty line}
+#' }
+#'
+#' @examples
+#'   # Access Benin PPI table
+#'   ppiBEN2022_11q
+#'
+#'   # Given a specific PPI score (from 0 - 100), get the row of poverty
+#'   # probabilities from PPI table it corresponds to
+#'   ppiScore <- 50
+#'   ppiBEN2022_11q[ppiBEN2022_11q$score == ppiScore, ]
+#'
+#'   # Use subset() function to get the row of poverty probabilities corresponding
+#'   # to specific PPI score
+#'   ppiScore <- 50
+#'   subset(ppiBEN2022_11q, score == ppiScore)
+#'
+#'   # Given a specific PPI score (from 0 - 100), get a poverty probability
+#'   # based on a specific poverty definition. In this example, the USAID
+#'   # extreme poverty definition
+#'   ppiScore <- 50
+#'   ppiBEN2022_11q[ppiBEN2022_11q$score == ppiScore, "nl100"]
+#'
+#' @source \url{https://www.povertyindex.org}
+#'
+#
+################################################################################
+"ppiBEN2022_11q"
+
+
+################################################################################
+#
+#' Poverty Probability Index (PPI) lookup table for Benin for 2022 for 6
+#' questions score card
+#'
+#' @format A data frame with 14 columns and 101 rows:
+#' \describe{
+#' \item{\code{score}}{PPI score}
+#' \item{\code{nl100}}{National poverty line (100\%)}
+#' \item{\code{nl150}}{National poverty line (150\%)}
+#' \item{\code{nl200}}{National poverty line (200\%)}
+#' \item{\code{ppp190}}{Below $1.90 per day purchasing power parity (2011)}
+#' \item{\code{ppp320}}{Below $3.20 per day purchasing power parity (2011)}
+#' \item{\code{ppp550}}{Below $5.50 per day purchasing power parity (2011)}
+#' \item{\code{ppp215}}{Below $2.15 per day purchasing power parity (2017)}
+#' \item{\code{ppp365}}{Below $3.65 per day purchasing power parity (2017)}
+#' \item{\code{ppp685}}{Below $6.85 per day purchasing power parity (2017)}
+#' \item{\code{percentile20}}{Below 20th percentile poverty line}
+#' \item{\code{percentile40}}{Below 40th percentile poverty line}
+#' \item{\code{percentile60}}{Below 60th percentile poverty line}
+#' \item{\code{percentile80}}{Below 80th percentile poverty line}
+#' }
+#'
+#' @examples
+#'   # Access Benin PPI table
+#'   ppiBEN2022_6q
+#'
+#'   # Given a specific PPI score (from 0 - 100), get the row of poverty
+#'   # probabilities from PPI table it corresponds to
+#'   ppiScore <- 50
+#'   ppiBEN2022_6q[ppiBEN2022_6q$score == ppiScore, ]
+#'
+#'   # Use subset() function to get the row of poverty probabilities corresponding
+#'   # to specific PPI score
+#'   ppiScore <- 50
+#'   subset(ppiBEN2022_6q, score == ppiScore)
+#'
+#'   # Given a specific PPI score (from 0 - 100), get a poverty probability
+#'   # based on a specific poverty definition. In this example, the USAID
+#'   # extreme poverty definition
+#'   ppiScore <- 50
+#'   ppiBEN2022_6q[ppiBEN2022_6q$score == ppiScore, "nl100"]
+#'
+#' @source \url{https://www.povertyindex.org}
+#'
+#
+################################################################################
+"ppiBEN2022_6q"

R/00_bolivia.R

@@ -0,0 +1,94 @@
+################################################################################
+#
+#' Poverty Probability Index (PPI) lookup table for Bolivia
+#'
+#' @format A data frame with 10 columns and 101 rows:
+#' \describe{
+#' \item{\code{score}}{PPI score}
+#' \item{\code{nl100}}{National poverty line (100\%)}
+#' \item{\code{nl150}}{National poverty line (150\%)}
+#' \item{\code{nl200}}{National poverty line (200\%)}
+#' \item{\code{half100}}{Poorest half below 100\% national}
+#' \item{\code{ppp125}}{Below $1.25 per day purchasing power parity (2005)}
+#' \item{\code{ppp200}}{Below $2.00 per day purchasing power parity (2005)}
+#' \item{\code{ppp250}}{Below $2.50 per day purchasing power parity (2005)}
+#' \item{\code{ppp500}}{Below $5.00 per day purchasing power parity (2005)}
+#' \item{\code{ppp844}}{Below $8.44 per day purchasing power parity (2005)}
+
+#' }
+#'
+#' @examples
+#'   # Access Bolivia PPI table
+#'   ppiBOL2015
+#'
+#'   # Given a specific PPI score (from 0 - 100), get the row of poverty
+#'   # probabilities from PPI table it corresponds to
+#'   ppiScore <- 50
+#'   ppiBOL2015[ppiBOL2015$score == ppiScore, ]
+#'
+#'   # Use subset() function to get the row of poverty probabilities corresponding
+#'   # to specific PPI score
+#'   ppiScore <- 50
+#'   subset(ppiBOL2015, score == ppiScore)
+#'
+#'   # Given a specific PPI score (from 0 - 100), get a poverty probability
+#'   # based on a specific poverty definition. In this example, the food
+#'   # poverty line definition
+#'   ppiScore <- 50
+#'   ppiBOL2015[ppiBOL2015$score == ppiScore, "nl100"]
+#'
+#' @source \url{https://www.povertyindex.org}
+#'
+#
+################################################################################
+"ppiBOL2015"
+
+
+################################################################################
+#
+#' Poverty Probability Index (PPI) lookup table for Bolivia for 2023
+#'
+#' @format A data frame with 15 columns and 101 rows:
+#' \describe{
+#' \item{\code{score}}{PPI score}
+#' \item{\code{nl100}}{National poverty line (100\%)}
+#' \item{\code{nl_extreme}}{National poverty line (extreme)}
+#' \item{\code{nl150}}{National poverty line (150\%)}
+#' \item{\code{nl200}}{National poverty line (200\%)}
+#' \item{\code{ppp190}}{Below $1.25 per day purchasing power parity (2011)}
+#' \item{\code{ppp320}}{Below $1.25 per day purchasing power parity (2011)}
+#' \item{\code{ppp550}}{Below $2.00 per day purchasing power parity (2011)}
+#' \item{\code{ppp215}}{Below $2.15 per day purchasing power parity (2017)}
+#' \item{\code{ppp365}}{Below $3.65 per day purchasing power parity (2017)}
+#' \item{\code{ppp685}}{Below $6.85 per day purchasing power parity (2017)}
+#' \item{\code{percentile20}}{Below 20th percentile poverty line}
+#' \item{\code{percentile40}}{Below 40th percentile poverty line}
+#' \item{\code{percentile60}}{Below 60th percentile poverty line}
+#' \item{\code{percentile80}}{Below 80th percentile poverty line}
+#' }
+#'
+#' @examples
+#'   # Access Bolivia PPI table
+#'   ppiBOL2023
+#'
+#'   # Given a specific PPI score (from 0 - 100), get the row of poverty
+#'   # probabilities from PPI table it corresponds to
+#'   ppiScore <- 50
+#'   ppiBOL2023[ppiBOL2023$score == ppiScore, ]
+#'
+#'   # Use subset() function to get the row of poverty probabilities corresponding
+#'   # to specific PPI score
+#'   ppiScore <- 50
+#'   subset(ppiBOL2023, score == ppiScore)
+#'
+#'   # Given a specific PPI score (from 0 - 100), get a poverty probability
+#'   # based on a specific poverty definition. In this example, the food
+#'   # poverty line definition
+#'   ppiScore <- 50
+#'   ppiBOL2023[ppiBOL2023$score == ppiScore, "nl100"]
+#'
+#' @source \url{https://www.povertyindex.org}
+#'
+#
+################################################################################
+"ppiBOL2023"