A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

pipr

Allows R users to compute poverty and inequality indicators for more than 160 countries and regions from the World Bank's database of household surveys.
https://github.com/worldbank/pipr

Category: Sustainable Development
Sub Category: Population and Poverty

Keywords

global-poverty poverty r worldbank

Last synced: about 24 hours ago
JSON representation

Repository metadata

R client to the PIP API

README.Rmd

          ---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# pipr


[![R-CMD-check](https://github.com/worldbank/pipr/workflows/R-CMD-check/badge.svg)](https://github.com/worldbank/pipr/actions?workflow=R-CMD-check)
[![test-coverage](https://github.com/worldbank/pipr/workflows/test-coverage/badge.svg)](https://github.com/worldbank/pipr/actions)
[![pkgdown](https://github.com/worldbank/pipr/workflows/pkgdown/badge.svg)](https://github.com/worldbank/pipr/actions)
[![Codecov test coverage](https://codecov.io/gh/worldbank/pipr/branch/main/graph/badge.svg)](https://app.codecov.io/gh/worldbank/pipr?branch=main)
[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)


The `pipr` package allows R users to compute poverty and inequality indicators 
for more than 160 countries and regions from the World Bank’s database of 
household surveys. It does so by accessing the Poverty and Inequality Platform 
(PIP) API. PIP is a computational tool that allows users to estimate poverty 
rates for regions, sets of countries or individual countries, over time and at 
any poverty line.

## Installation

You can install the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("worldbank/pipr")
```

## Example

This is a basic example that shows how to retrieve some key poverty and inequity statistics. 

### Retrieve statistics

```{r example, warning=FALSE, message=FALSE}
library(dplyr)
library(pipr)

df <- get_stats(country = "ALB")
glimpse(df)
```

### Access data dictionary
```{r}
get_dictionary()
```


## Citation

To cite package `pipr` in publications use:

```
  Tony Fujs, Aleksander Eilertsen, Ronak Shah and R. Andrés Castañeda (2022). pipr: Client for the PIP
  API. https://github.com/worldbank/pipr, https://worldbank.github.io/pipr/.
```

A BibTeX entry for LaTeX users is

```
  @Manual{,
    title = {pipr: Client for the PIP API},
    author = {Tony Fujs and Aleksander Eilertsen and Ronak Shah and R. Andrés Castañeda},
    year = {2022},
    note = {https://github.com/worldbank/pipr,https://worldbank.github.io/pipr/},
  }
```


        

Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 7 days ago

Total Commits: 178
Total Committers: 7
Avg Commits per committer: 25.429
Development Distribution Score (DDS): 0.624

Commits in past year: 32
Committers in past year: 2
Avg Commits per committer in past year: 16.0
Development Distribution Score (DDS) in past year: 0.156

Name Email Commits
Tony Fujs t****s@g****m 67
Aleksander Eilertsen a****n@w****g 36
giorgiacek g****a@g****m 27
Ronak Shah s****7@y****n 24
R.Andres Castaneda a****a@w****g 12
Andres a****a@w****g 9
Tony Henri Mathias Jany Fujs t****s@w****g 3

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 52
Total pull requests: 69
Average time to close issues: 14 days
Average time to close pull requests: 20 days
Total issue authors: 7
Total pull request authors: 5
Average comments per issue: 0.42
Average comments per pull request: 0.61
Merged pull request: 59
Bot issues: 0
Bot pull requests: 0

Past year issues: 0
Past year pull requests: 7
Past year average time to close issues: N/A
Past year average time to close pull requests: 5 days
Past year issue authors: 0
Past year pull request authors: 1
Past year average comments per issue: 0
Past year average comments per pull request: 0.29
Past year merged pull request: 4
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/worldbank/pipr

Top Issue Authors

  • tonyfujs (22)
  • Aeilert (21)
  • qq474849277 (3)
  • shahronak47 (3)
  • msgoussi (1)
  • morkor (1)
  • ryancbriggs (1)

Top Pull Request Authors

  • tonyfujs (27)
  • shahronak47 (15)
  • Aeilert (11)
  • randrescastaneda (9)
  • giorgiacek (7)

Top Issue Labels

  • enhancement (25)
  • documentation (5)
  • bug (3)

Top Pull Request Labels

  • enhancement (8)

Dependencies

DESCRIPTION cran
  • R >= 3.5.0 depends
  • attempt * imports
  • cachem * imports
  • curl * imports
  • data.table * imports
  • httr * imports
  • jsonlite * imports
  • memoise * imports
  • purrr * imports
  • tibble * imports
  • callr * suggests
  • covr * suggests
  • knitr * suggests
  • markdown * suggests
  • rmarkdown * suggests
  • spelling * suggests
  • testthat >= 3.0.0 suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/check-r-package v1 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite
.github/workflows/pkgdown.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite
.github/workflows/pr-commands.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/pr-fetch v1 composite
  • r-lib/actions/pr-push v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-r-dependencies v1 composite
.github/workflows/render-readme.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-pandoc v1 composite
  • r-lib/actions/setup-r v1 composite
  • r-lib/actions/setup-renv v1 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite

Score: 5.556828061699537