pip_group {worldbank} | R Documentation |
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 |
character() countries for which statistics are to be computed,
specified as ISO3 codes. Default NULL .
|
year |
character() | numeric() year(s) 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 |
numeric(1) proportion of the population living below the poverty
line. Will be ignored if povline is specified. 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 |
character(1) version of the data release in YYYYMMDD format.
Default NULL .
|
ppp_version |
character(1) | numeric(1) version of the data. Default NULL .
|
version |
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_data()
,
pip_health_check()
,
pip_info()
,
pip_valid_params()
,
pip_versions()
Examples
pip_group(c("AFE", "LAC"))
[Package
worldbank version 0.3.0
Index]