Return valid query parameters — pip_valid_params • worldbank

Return valid query parameters

Usage

pip_valid_params(
  endpoint = c("all", "aux", "pip", "pip-grp", "pip-info", "valid-params"),
  release_version = NULL,
  ppp_version = NULL,
  version = NULL
)

Source

https://pip.worldbank.org/api

Arguments

endpoint: (character(1)) endpoint for which valid parameters are to be returned. Default "all".
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 valid parameters.

See also

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

Examples

# \donttest{
pip_valid_params()
#> Error in req_perform(req_url_query(req_error(req_url_path_append(req_user_agent(request("https://api.worldbank.org/pip/v1"),     "worldbank (https://m-muecke.github.io/worldbank)"), resource),     body = pip_error_body), format = format, ...)): HTTP 502 Bad Gateway.
# }