Client for the Poverty and Inequality Platform ('PIP') API
Overview
An interface to compute poverty and inequality indicators for more than 160 countries and regions from the World Bank's database of household surveys, through the Poverty and Inequality Portal (PIP).
get_stats(),get_cp(),get_cp_ki(), andget_aux()now check their arguments before making an API request. Invalid country codes, years, poverty lines, population shares, data versions, dates, response formats, and other options produce an error that names the argument. Country codes must be uppercase three-letter codes (or"all"where supported);get_cp_ki()requires exactly one country code. Inputs that were previously sent to the API without local validation may now fail before the request.- Tests for the 2011 PPP poverty-line defaults in
get_cp()andget_cp_ki()now use mocked responses because the live API rejects these requests. Automated CRAN-mode checks skip live API integration tests so temporary gateway failures do not fail package checks. The package website displays examples without making live API requests during deployment.
Show all changes in 1.5.0Hide the rest of the changes in 1.5.0
- Corrected API argument, return-value, and example documentation. The
call_aux()example no longer makes a network request during package checks.
From NEWS.md in the release
Install
Health
- OK13 OK2026-08-05
- ERROR12 OK, 1 ERROR2026-08-04
- NOTE12 OK, 1 NOTE2026-08-01
- OK13 OK2026-07-18
- ERROR12 OK, 1 ERROR2026-07-16
Show 13 earlier changesHide 13 earlier changes
- OK13 OK2026-07-10
- ERROR12 OK, 1 ERROR2026-07-05
- OK13 OK2026-07-01
- ERROR12 OK, 1 ERROR2026-06-30
- OK13 OK2026-05-31
- ERROR12 OK, 1 ERROR2026-05-30
- OK13 OK2026-05-28
- ERROR12 OK, 1 ERROR2026-05-22
- OK13 OK2026-05-21
- ERROR12 OK, 1 ERROR2026-05-14
- OK14 OK2026-04-07
- ERROR13 OK, 1 ERROR2026-04-04
- OK14 OK2026-03-10
Documentation
The repository also keeps web-only articles.
- Help pages
- 26 (4 internal)
- Examples that run
- 100%13 run in a plain check (10 of them under a condition)
- Exported functions with examples
- 100%
- Documented parameters
- 100%
- Return-value docs
- 100%
- Help pages citing references
- 0%
Downloads
Repository
- PRs merged (all time)
- 87%
- Median days to close, 50 most recently updated closed issues
- 8
- Median days to close, 50 most recently updated closed PRs
- 1
Stars over time
Forks over time
Releases over time
Issues over time
PRs over time
Commits over time
Commit identities over time
15 development-tooling and community-health practices detected across 7 families in the upstream repository
Checks run against github.com/worldbank/pipr on 2026-10-21.
The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel
GitHub Pages site last deployed 2026-10-02 · The repository has a site deploy workflow
pkgdown site last built 2026-10-02
Show all practicesHide 3 practices
Dependencies
Code & Tests
Datasets
People & History
Pick two releases to compare their code metrics.
- unarchivedReturned to CRAN2026-09-30
- 1.5.0Latest
- archivedRemoved from CRAN2026-08-24policy violation On Internet access (intermittent)
- RR 4.6.0 released · 2026-04-24
- 1.4.02025-12-22
- RR 4.5.0 released · 2025-04-11
Package metadata
- First published
- 2025-12-22
- Total releases
- 2 / 1 yrs
- License
- MIT + file LICENSE OSI
- Minimum R
- ≥ 4.1.0
- Bundled data
- 1.6 KB / 2 files
- Download size
- 718 KB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("pipr")This package has no citation file, so citation() returns this entry built from DESCRIPTION.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-24, which the citation names so these numbers can be found later. More on citing and the projects behind them.