Data

Tools

Indexes

Applications

Experiments

Open Source Science

pipr

R client to the PIP API

https://github.com/worldbank/pipr

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.6%) to scientific vocabulary

Keywords

global-poverty poverty r worldbank

Keywords from Contributors

povcalnet
Last synced: 9 months ago · JSON representation

Repository

R client to the PIP API

Basic Info
Statistics
  • Stars: 20
  • Watchers: 7
  • Forks: 4
  • Open Issues: 19
  • Releases: 3
Topics
global-poverty poverty r worldbank
Created about 4 years ago · Last pushed 10 months ago
Metadata Files
Readme Changelog Contributing License

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)
[![R-CMD-check](https://github.com/worldbank/pipr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/worldbank/pipr/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/worldbank/pipr/graph/badge.svg)](https://app.codecov.io/gh/worldbank/pipr)


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
# From CRAN
install.packages("devtools")

# From Github
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_aux("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

  • Name: World Bank Group
  • Login: worldbank
  • Kind: organization
  • Email: github@worldbank.org

World Bank Repository for Data Products and tools. Content does not necessarily represent official World Bank Group positions, policies, recommendations, etc.

GitHub Events

Total
  • Watch event: 7
  • Delete event: 2
  • Issue comment event: 2
  • Push event: 37
  • Pull request review comment event: 1
  • Pull request review event: 3
  • Pull request event: 16
  • Create event: 7
Last Year
  • Watch event: 7
  • Delete event: 2
  • Issue comment event: 2
  • Push event: 37
  • Pull request review comment event: 1
  • Pull request review event: 3
  • Pull request event: 16
  • Create event: 7

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 208
  • Total Committers: 7
  • Avg Commits per committer: 29.714
  • Development Distribution Score (DDS): 0.678
Past Year
  • Commits: 61
  • Committers: 3
  • Avg Commits per committer: 20.333
  • Development Distribution Score (DDS): 0.262
Top Committers
Name Email Commits
Tony Fujs t****s@g****m 67
giorgiacek g****a@g****m 45
Aleksander Eilertsen a****n@w****g 36
Ronak Shah s****7@y****n 27
R.Andres Castaneda a****a@w****g 21
Andres a****a@w****g 9
Tony Henri Mathias Jany Fujs t****s@w****g 3
Committer Domains (Top 20 + Academic)
worldbank.org: 4 yahoo.in: 1

Issues and Pull Requests

Last synced: 9 months ago

All Time
  • Total issues: 33
  • Total pull requests: 59
  • Average time to close issues: 20 days
  • Average time to close pull requests: about 2 months
  • Total issue authors: 8
  • Total pull request authors: 5
  • Average comments per issue: 0.39
  • Average comments per pull request: 0.51
  • Merged pull requests: 47
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 16
  • Average time to close issues: N/A
  • Average time to close pull requests: 17 days
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.19
  • Merged pull requests: 10
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • tonyfujs (13)
  • Aeilert (12)
  • shahronak47 (3)
  • qq474849277 (1)
  • msgoussi (1)
  • randrescastaneda (1)
  • morkor (1)
  • ryancbriggs (1)
Pull Request Authors
  • tonyfujs (20)
  • giorgiacek (14)
  • shahronak47 (12)
  • Aeilert (7)
  • randrescastaneda (6)
Top Labels
Issue Labels
enhancement (14) documentation (3) bug (2)
Pull Request Labels
enhancement (5)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 3
proxy.golang.org: github.com/worldbank/pipr
  • Versions: 3
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.4%
Average: 5.6%
Dependent repos count: 5.8%
Last synced: 9 months ago

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