Merge pull request #81 from katilingban/dev

refresh repository

DESCRIPTION

@@ -23,7 +23,7 @@ Imports:
     tibble,
     tidyr
 Suggests: 
-    testthat,
+    testthat (>= 3.0.0),
     covr,
     spelling,
     stringr,
@@ -32,5 +32,6 @@ Encoding: UTF-8
 Language: en-GB
 LazyData: true
 RoxygenNote: 7.3.1
-URL: https://github.com/katilingban/ppitables,https://katilingban.io/ppitables/
+URL: https://github.com/katilingban/ppitables, https://katilingban.io/ppitables/
 BugReports: https://github.com/katilingban/ppitables/issues
+Config/testthat/edition: 3

R/ppitables.R

@@ -1,5 +1,3 @@
-################################################################################
-#
 #'
 #' Poverty Probability Index (PPI) Lookup Tables
 #'
@@ -16,8 +14,6 @@
 #' @importFrom tibble tibble
 #' @importFrom tidyr pivot_longer
 #'
-#
-################################################################################
 "_PACKAGE"
 
 

README.Rmd

@@ -19,7 +19,7 @@ library(ppitables)
 [![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
 [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/ppitables)](https://cran.r-project.org/package=ppitables)
-[![cran checks](https://cranchecks.info/badges/summary/ppitables)](https://cran.r-project.org/web/checks/check_results_ppitables.html)
+[![cran checks](https://badges.cranchecks.info/worst/ppitables.svg)](https://cran.r-project.org/web/checks/check_results_ppitables.html)
 [![CRAN](https://img.shields.io/cran/l/ppitables.svg)](https://github.com/katilingban/ppitables/blob/master/LICENSE.md)
 [![CRAN](http://cranlogs.r-pkg.org/badges/ppitables)](https://CRAN.R-project.org/package=ppitables)
 [![CRAN](http://cranlogs.r-pkg.org/badges/grand-total/ppitables)](https://CRAN.R-project.org/package=ppitables)
@@ -38,15 +38,15 @@ You can install `ppitables` from CRAN with:
 
 ```{r cran, eval = FALSE}
 install.packages("ppitables")
-library(ppitables)
 ```
 
-You can install the current development version of `ppitables` from GitHub with:
+You can install the current development version from the `Katilingban R-universe`[https://katilingban.r-universe.dev]:
 
 ```{r gh-installation, eval = FALSE}
-if(!require("remotes")) install.packages("remotes")
-remotes::install_github("katilingban/ppitables")
-library(ppitables)
+install.packages(
+  "ppitables",
+  c('https://nutriverse.r-universe.dev', 'https://cloud.r-project.org')
+)
 ```
 
 ## Usage
@@ -406,6 +406,14 @@ The `ppitables` package is an independent development and is separate from and n
 
 Any mistakes, problems and issues with the functionality and outputs of the `ppitables` package are that of the author and maintainer of the package and not of *[International Poverty Alliance (IPA)](http://www.poverty-action.org/)*. Hence any problems and issues to the usage, functionality and outputs of the `ppitables` package should be addressed directly to the author and maintainer [here](https://github.com/katilingban/ppitables/issues).
 
+## Citation
+
+If you find the `ppitables` package useful, please cite using the suggested citation provided by a call to the `citation` function as follows:
+
+```{r citation, echo = TRUE, eval = TRUE}
+citation("ppitables")
+```
+
 ## Community guidelines
 
 Feedback, bug reports and feature requests are welcome; file issues or seek support [here](https://github.com/katilingban/ppitables/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://katilingban.io/ppitables/CONTRIBUTING.html).

README.md

@@ -12,7 +12,7 @@ developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.re
 stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
 [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/ppitables)](https://cran.r-project.org/package=ppitables)
 [![cran
-checks](https://cranchecks.info/badges/summary/ppitables)](https://cran.r-project.org/web/checks/check_results_ppitables.html)
+checks](https://badges.cranchecks.info/worst/ppitables.svg)](https://cran.r-project.org/web/checks/check_results_ppitables.html)
 [![CRAN](https://img.shields.io/cran/l/ppitables.svg)](https://github.com/katilingban/ppitables/blob/master/LICENSE.md)
 [![CRAN](http://cranlogs.r-pkg.org/badges/ppitables)](https://CRAN.R-project.org/package=ppitables)
 [![CRAN](http://cranlogs.r-pkg.org/badges/grand-total/ppitables)](https://CRAN.R-project.org/package=ppitables)
@@ -37,16 +37,16 @@ You can install `ppitables` from CRAN with:
 
 ``` r
 install.packages("ppitables")
-library(ppitables)
 ```
 
-You can install the current development version of `ppitables` from
-GitHub with:
+You can install the current development version from the
+`Katilingban R-universe`\[<https://katilingban.r-universe.dev>\]:
 
 ``` r
-if(!require("remotes")) install.packages("remotes")
-remotes::install_github("katilingban/ppitables")
-library(ppitables)
+install.packages(
+  "ppitables",
+  c('https://nutriverse.r-universe.dev', 'https://cloud.r-project.org')
+)
 ```
 
 ## Usage
@@ -863,7 +863,7 @@ command in R:
 
 ``` r
 find_table()
-#> # A tibble: 91 × 7
+#> # A tibble: 93 × 7
 #>    region            country survey_year release_year description type  filename
 #>    <chr>             <chr>         <int>        <int> <chr>       <chr> <chr>   
 #>  1 Asia              Afghan…        2007         2012 PPI for Af… sps   ppiAFG2…
@@ -876,15 +876,15 @@ find_table()
 #>  8 Africa            Burkin…        2014         2017 PPI for Bu… sps   ppiBFA2…
 #>  9 Africa            Burkin…        2014         2017 PPI for Bu… ipa   ppiBFA2…
 #> 10 Asia              Cambod…        2011         2015 PPI for Ca… sps   ppiKHM2…
-#> # ℹ 81 more rows
+#> # ℹ 83 more rows
 ```
 
 View the list of PPI country tables for Africa using the following
 command in R:
 
 ``` r
 find_table(region = "Africa")
-#> # A tibble: 39 × 7
+#> # A tibble: 41 × 7
 #>    region country       survey_year release_year description      type  filename
 #>    <chr>  <chr>               <int>        <int> <chr>            <chr> <chr>   
 #>  1 Africa Angola               2008         2015 PPI for Angola … sps   ppiAGO2…
@@ -897,7 +897,7 @@ find_table(region = "Africa")
 #>  8 Africa Cote d'Ivoire        2015         2018 PPI for Ivory C… ipa   ppiCIV2…
 #>  9 Africa Ethiopia             2010         2016 PPI for Ethiopi… sps   ppiETH2…
 #> 10 Africa Ghana                2012         2015 PPI for Ghana b… sps   ppiGHA2…
-#> # ℹ 29 more rows
+#> # ℹ 31 more rows
 ```
 
 View the list of PPI country tables in Zambia using the the following
@@ -924,7 +924,7 @@ tables, the following command can be used in R:
 
 ``` r
 get_table()
-#> # A tibble: 93,088 × 7
+#> # A tibble: 96,288 × 7
 #>    country     release_year filename   type  score poverty_definition   ppi
 #>    <chr>       <chr>        <chr>      <chr> <dbl> <chr>              <dbl>
 #>  1 Afghanistan 2012         ppiAFG2012 sps       0 nl                   100
@@ -937,15 +937,15 @@ get_table()
 #>  8 Afghanistan 2012         ppiAFG2012 sps       1 nu150                100
 #>  9 Afghanistan 2012         ppiAFG2012 sps       1 nu200                100
 #> 10 Afghanistan 2012         ppiAFG2012 sps       1 extreme              100
-#> # ℹ 93,078 more rows
+#> # ℹ 96,278 more rows
 ```
 
 To get the actual PPI tables for all countries with PPI tables in
 Africa, the following command can be used in R:
 
 ``` r
 get_table(region = "Africa")
-#> # A tibble: 44,122 × 7
+#> # A tibble: 47,322 × 7
 #>    country release_year filename   type  score poverty_definition   ppi
 #>    <chr>   <chr>        <chr>      <chr> <dbl> <chr>              <dbl>
 #>  1 Angola  2015         ppiAGO2015 sps       0 nl100              100  
@@ -958,7 +958,7 @@ get_table(region = "Africa")
 #>  8 Angola  2015         ppiAGO2015 sps       0 ppp500             100  
 #>  9 Angola  2015         ppiAGO2015 sps       1 nl100              100  
 #> 10 Angola  2015         ppiAGO2015 sps       1 nl150              100  
-#> # ℹ 44,112 more rows
+#> # ℹ 47,312 more rows
 ```
 
 ## Disclaimer
@@ -981,6 +981,33 @@ to the usage, functionality and outputs of the `ppitables` package
 should be addressed directly to the author and maintainer
 [here](https://github.com/katilingban/ppitables/issues).
 
+## Citation
+
+If you find the `ppitables` package useful, please cite using the
+suggested citation provided by a call to the `citation` function as
+follows:
+
+``` r
+citation("ppitables")
+#> To cite ppitables in publications use:
+#> 
+#>   Ernest Guevarra (2024). _ppitables: Lookup Tables to Generate Poverty
+#>   Likelihoods and Rates using the Poverty Probability Index (PPI)_.
+#>   doi:10.5281/zenodo.4129982 <https://doi.org/10.5281/zenodo.4129982>,
+#>   R package version 0.5.5, <https://katilingban.io/ppitables/>.
+#> 
+#> A BibTeX entry for LaTeX users is
+#> 
+#>   @Manual{,
+#>     title = {ppitables: Lookup Tables to Generate Poverty Likelihoods and Rates using the Poverty Probability Index (PPI)},
+#>     author = {{Ernest Guevarra}},
+#>     year = {2024},
+#>     note = {R package version 0.5.5},
+#>     url = {https://katilingban.io/ppitables/},
+#>     doi = {10.5281/zenodo.4129982},
+#>   }
+```
+
 ## Community guidelines
 
 Feedback, bug reports and feature requests are welcome; file issues or