Skip to contents

Return valid query parameters

Source: R/pip.R
pip_valid_params.Rd

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

(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 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{
params <- pip_valid_params()
head(params)
#>   param_names param_values param_boundaries param_types
#> 1     country          ALL             <NA>   character
#> 2     country          AFE             <NA>   character
#> 3     country          AFW             <NA>   character
#> 4     country          AGO             <NA>   character
#> 5     country          ALB             <NA>   character
#> 6     country          ARE             <NA>   character
# }