Merge pull request #67 from katilingban/v0.5.4

V0.5.4; fixes #66

Author: ernestguevarra

DESCRIPTION

@@ -2,7 +2,7 @@ Package: ppitables
 Type: Package
 Title: Lookup Tables to Generate Poverty Likelihoods and Rates using the Poverty 
     Probability Index (PPI)
-Version: 0.5.3
+Version: 0.5.4
 Authors@R: person("Ernest", "Guevarra", 
                   comment = c(ORCID = "0000-0002-4887-4415"), 
                   email = "[email protected]", role = c("aut", "cre"))

NEWS.md

@@ -1,3 +1,16 @@
+# ppitables 0.5.4
+
+This is the ninth CRAN release of `ppitables`. In this release, I added:
+
+* new PPI tables for Indonesia using the new PPI calculation approach developed
+by the International Poverty Alliance (IPA) based on data from Indonesia's
+SUSENA 2016
+
+* updated `steer` data that serves as an index to the tables to include the new
+Indonesia PPI tables
+
+* general documentation updates and general checking updates
+
 # ppitables 0.5.3
 
 This is the eighth CRAN release of `ppitables`. In this release, I added:

R/data.R

@@ -3858,3 +3858,57 @@
 #
 ################################################################################
 "ppiMWI2020"
+
+################################################################################
+#
+#' Poverty Probability Index (PPI) lookup table for Indonesia
+#'
+#' @format A data frame with 20 columns and 100 rows:
+#' \describe{
+#' \item{\code{score}}{PPI score}
+#' \item{\code{nl100}}{National poverty line (100\%)}
+#' \item{\code{extreme}}{Extreme poverty line}
+#' \item{\code{nl150}}{National poverty line (150\%)}
+#' \item{\code{nl200}}{National poverty line (200\%)}
+#' \item{\code{ppp100}}{Below $1.00 per day purchasing power parity (2011)}
+#' \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{ppp800}}{Below $8.00 per day purchasing power parity (2011)}
+#' \item{\code{ppp1100}}{Below $11.00 per day purchasing power parity (2011)}
+#' \item{\code{ppp1500}}{Below $15.00 per day purchasing power parity (2011)}
+#' \item{\code{ppp2170}}{Below $21.70 per day purchasing power parity (2011)}
+#' \item{\code{ppp125}}{Below $1.25 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{percentile20}}{Below 20th percentile poverty line}
+#' \item{\code{percentile40}}{Below 40th percentile poverty line}
+#' \item{\code{percentile60}}{Below 50th percentile poverty line}
+#' \item{\code{percentile80}}{Below 60th percentile poverty line}
+#' }
+#'
+#' @examples
+#'   # Access Indonesia PPI table
+#'   ppiIDN2020
+#'
+#'   # Given a specific PPI score (from 0 - 100), get the row of poverty
+#'   # probabilities from PPI table it corresponds to
+#'   ppiScore <- 50
+#'   ppiIDN2020[ppiIDN2020$score == ppiScore, ]
+#'
+#'   # Use subset() function to get the row of poverty probabilities corresponding
+#'   # to specific PPI score
+#'   ppiScore <- 50
+#'   subset(ppiIDN2020, 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
+#'   ppiIDN2020[ppiIDN2020$score == ppiScore, "extreme"]
+#'
+#' @source \url{https://www.povertyindex.org}
+#'
+#
+################################################################################
+"ppiIDN2020"

R/sysdata.rda

@@ -69,7 +69,7 @@ These three components are joined together without any spaces or gaps.
 
 Some country lookup tables may have additional components to their name which are added after the year separated with an underscore. These usually signify that a lookup table released on a particular year has a subset table in which the poverty likelihoods for a given `PPI` score are reported based on a different poverty definition or cut-off. This additional component to the table name is usually a character value or alphanumeric and is usually country-specific. To know more about what this additional component to some `PPI` tables refer to, read the index table below of the `PPI` tables available in this package. 
 
-Following are the available PPI country tables from the `ppitables` package. This is updated as at 20 September 2020 using information from the PPI [site](https://www.povertyindex.org).
+Following are the available PPI country tables from the `ppitables` package. This is updated as at 21 September 2020 using information from the PPI [site](https://www.povertyindex.org).
 
 
 ### List of PPI country tables
@@ -171,6 +171,9 @@ Following are the available PPI country tables from the `ppitables` package. Thi
 |     | `ppiIDN2012_a`  | PPI for Indonesia based on data from 2010 using new | 2012            |
 |     |                 | definition poverty lines                            |                 |
 +-----+-----------------+-----------------------------------------------------+-----------------+
+|     | `ppiIDN2020`    | PPI for Indonesia based on data from Indonesia's    | 2020            |
+|     |                 | SUSENA 2016                                         |                 |
++-----+-----------------+-----------------------------------------------------+-----------------+
 | 21. | `ppiIND2016_r59`| PPI for India using India’s 2011/12 Socio-Economic  | 2016            |
 |     |                 | using the R59 legacy poverty lines using MRP        |                 |
 |     |                 | consumption                                         |                 |