pip_data: Return main poverty and inequality statistics

In worldbank: Client for World Banks's 'Indicators' and 'Poverty and Inequality Platform (PIP)' APIs

Return main poverty and inequality statistics

Description

Return main poverty and inequality statistics

Usage

pip_data(
  country = NULL,
  year = NULL,
  povline = 2.15,
  popshare = NULL,
  fill_gaps = FALSE,
  welfare_type = c("all", "consumption", "income"),
  reporting_level = c("all", "national", "rural", "urban"),
  additional_ind = FALSE,
  release_version = NULL,
  ppp_version = NULL,
  version = NULL
)

Arguments

country	(NULL | character()) Countries for which statistics are to be computed, specified as ISO3 codes. Default NULL.
year	(NULL | character() | numeric()) Years for which statistics are to be computed, specified as YYYY. Default NULL.
povline	(numeric(1)) Poverty line to be used to compute poverty mesures. Poverty lines are only accepted up to 3 decimals. Default 2.15.
popshare	(NULL | numeric(1)) Proportion of the population living below the poverty line. Will be ignored if povline is specified. Default NULL.
fill_gaps	(logical(1)) Whether to fill gaps in the data. Default FALSE.
welfare_type	(character(1)) Type of welfare measure to be used. Default "all".
reporting_level	(character(1)) level of reporting for the statistics. Default "all".
additional_ind	(logical(1)) Whether to include additional indicators. Default FALSE.
release_version	(NULL | character(1)) Version of the data release in YYYYMMDD format. Default NULL.
ppp_version	(NULL | character(1) | numeric(1)) Version of the data. Default NULL.
version	(NULL | character(1)) Version of the data. Default NULL.

Value

A data.frame() with the requested statistics.

Source

https://pip.worldbank.org/api

See Also

Other poverty and inequality statistics: pip_aux(), pip_citation(), pip_group(), pip_health_check(), pip_info(), pip_valid_params(), pip_versions()

Examples

data <- pip_data(c("ZAF", "ZMB"))
head(data)

worldbank documentation built on Nov. 10, 2025, 5:06 p.m.