Return valid query parameters

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()
#> # A tibble: 350 × 4
#>    param_names param_values param_boundaries param_types
#>    <chr>       <chr>        <chr>            <chr>      
#>  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  
#>  7 country     ARG          NA               character  
#>  8 country     ARM          NA               character  
#>  9 country     AUS          NA               character  
#> 10 country     AUT          NA               character  
#> # ℹ 340 more rows
# }