Skip to content

Client for the Poverty and Inequality Platform ('PIP') API

0packages depend
2.4Kdownloads / year
74.5%test coverage
13/13flavors OK

Overview

About

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).

Changes in 1.5.0
  • get_stats(), get_cp(), get_cp_ki(), and get_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() and get_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

CRAN checks
13OK
Slowest check: 1.2 min · r-oldrel-windows-x86_64
Status changes
  • 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
Advisories

none known

Documentation

In release 1.5.0
READMEYes · 136 wordsVignettesNoNEWSYes · 100% structured · mentions 1.5.0Citation fileNoWebsiteYes · pkgdown

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

2.4K
CRAN downloads in the past year
Rank #23,571 · ~6/day · ~196/mo
Daily download trend is not available in this view yet.
36030 days
55090 days
2.4K1 year
Compare downloads with other packages →
Also on53 r2u7 autocran

Repository

23Stars
4Forks
21Open issues
1Open PRs
6Releases
294Commits
9Commit identities
rpovertyglobal-povertyworldbank
294 commits · Last activity 2026-10-02 · +4.5% stars, 30d
Responsiveness
How these are sampled
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

2025-09-09 · 212026-10-01 · 23
PracticesBeta

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.

Continuous integration (2)
GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Governance and community (4)
Code of conduct (inherited from worldbank)Contributing guideIssue templatesPR template
Docs source (4)
README.Rmdpkgdown

GitHub Pages site last deployed 2026-10-02 · The repository has a site deploy workflow

pkgdown site last built 2026-10-02

Coverage (1)
Coverage reporting (Codecov)
Show all practicesHide 3 practices
Reproducibility and dev environment (1)
data-raw/
CRAN release process (2)
cran-comments.mdCRAN-SUBMISSION
Lint, format, editor (1)
RStudio project
How this is detected·Detection ruleset v4 (2026-10-20)

Dependencies

Declared dependencies
25 external dependencies (excludes base and recommended)

Installing pipr adds 34 packages (20 with compiled code, 25 MB of source tarballs). Heaviest: stringi 11 MB, arrow 4.2 MB, openssl 1.1 MB.

Depends (1)
R >= 4.1.0
LinkingTo (0)
none
Enhances (0)
none
Reverse dependencies
0direct
0indirect

Nothing depends on this yet.

Datasets

People & History

People (6)
Author, Maintainer since 1.4.0 (2025)
Author
Copyright holder
Releases (2)

Pick two releases to compare their code metrics.

  • unarchivedReturned to CRAN
    2026-09-30
  • 1.5.0Latest
    record
    2026-09-30 · current release · diff ↗
  • archivedRemoved from CRAN
    2026-08-24
    policy violation On Internet access (intermittent)
  • R
    R 4.6.0 released · 2026-04-24
  • 1.4.0
    record
    2025-12-22
  • R
    R 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")
Castañeda, R. A., World Bank, Cecchinato, G., Eilertsen, A., Fujs, T., & Shah, R. (2026). pipr: Client for the Poverty and Inequality Platform ('PIP') API (Version 1.5.0) [Computer software]. https://doi.org/10.32614/CRAN.package.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.

APA

Balamuta, J. J. (2026). R Observatory: Metrics for pipr version 1.5.0 [Data set]. HJJB, LLC. Data release v2026-10-24. https://doi.org/10.5281/zenodo.21843040

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.

Report a problem with this page →

Privacy choices

These apply to this browser and are stored on this device only. Nothing about your choice is sent to us.

Read the privacy policy