get_cp: Get Country Profiles

In worldbank/pipr: Client for the Poverty and Inequality Platform ('PIP') API

Get Country Profiles

Description

Get Country Profiles

Usage

get_cp(
  country = "all",
  povline = 2.15,
  version = NULL,
  ppp_version = 2017,
  release_version = NULL,
  api_version = "v1",
  format = c("arrow", "rds", "json", "csv"),
  simplify = TRUE,
  server = NULL
)

Arguments

country	character: A vector with one or more country ISO 3 codes or 'all'
povline	numeric: Poverty line
version	character: Data version. See get_versions()
ppp_version	ppp year to be used
release_version	date when the data was published in YYYYMMDD format
api_version	character: API version
format	character: Response format either of c("rds", "json", "csv")
simplify	logical: If TRUE (the default) the response is returned as a tibble
server	character: Server. For WB internal use only

Value

If simplify = FALSE, it returns a list of class "pip_api". If simplify = TRUE, it returns a tibble with the requested data. This is the default. Only for get_aux(), If assign_tb = TRUE or character, it returns TRUE when data was assign properly to .pip env. FALSE, if it was not assigned.

Examples

## Not run: 
# One country, all years with default ppp_version = 2017
res <- get_cp(country = "AGO")

# All countries, povline = 1.9
res <- get_cp(povline = 1.9)

# All countries and years with default values
res <- get_cp()

## End(Not run)

worldbank/pipr documentation built on Dec. 22, 2024, 7:08 a.m.