pipr (version 1.5.0)

get_cp_ki: Get Country Profiles Key Indicators

Description

Get Country Profiles Key Indicators

Usage

get_cp_ki(
  country = NULL,
  povline = 2.15,
  version = NULL,
  ppp_version = 2017,
  release_version = NULL,
  api_version = "v1",
  simplify = TRUE,
  server = NULL
)

Value

An unnested data frame of key indicators when simplify = TRUE, or a pip_api list when simplify = FALSE.

Arguments

country

One uppercase, three-letter country ISO code (required).

povline

One finite, non-negative numeric poverty line, or NULL. With ppp_version = 2011, NULL sends 1.9; otherwise the API applies its default poverty line.

version

Data version in YYYYMMDD_PPP_XX_YY_IDENTITY format, or NULL. See get_versions().

ppp_version

One integer-valued numeric PPP year, a four-digit year string, or NULL.

release_version

A valid publication date in YYYYMMDD format, or NULL.

api_version

API version. Currently only "v1" is supported.

simplify

One non-missing logical value. If TRUE (the default), return simplified data.

server

One non-empty server name, or NULL for the production server. For World Bank internal use only.

Examples

if (interactive()) {
# One country, all years with default ppp_version = 2017
res <- get_cp_ki(country = "IDN")

# One country, povline = 1.9
res <- get_cp_ki(country = "IDN", povline = 1.9)

}