pip_group: Return aggregation of PIP statistics

In worldbank: Client for the 'World Bank' APIs

Return aggregation of PIP statistics

Description

Return aggregation of PIP statistics

Usage

pip_group(
  country = NULL,
  year = NULL,
  povline = 2.15,
  popshare = NULL,
  group_by = c("wb", "none"),
  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	(NULL | numeric(1)) Poverty line to be used to compute poverty measures, between 0 and 2700. 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, between 0 and 1. Takes precedence over povline: if both are supplied, the poverty line is derived from popshare. Default NULL.
group_by	(character(1)) Aggregate results by pre-defined sub-groups. Default "wb".
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) | numeric(1)) Version of the data release in YYYYMMDD format. Default NULL.
ppp_version	(NULL | character(1) | numeric(1)) Version of the data in YYYY format. 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_cp(), pip_data(), pip_health_check(), pip_info(), pip_valid_params(), pip_versions()

Examples

grp <- pip_group(c("AFE", "LAC"))
head(grp)

worldbank documentation built on Aug. 21, 2026, 9:07 a.m.