povcalnet_cl: povcalnet_cl Facilitate interaction with the PovcalNet API....

In worldbank/povcalnetR: Client for the 'Povcalnet' API

povcalnet_cl Facilitate interaction with the PovcalNet API. All parameters are specified at the country level (hence the _cl suffix), so if you send a request for two countries, you must also pass two values to the 'year' argument, two values to the 'povline' argument, etc.

Description

povcalnet_cl Facilitate interaction with the PovcalNet API. All parameters are specified at the country level (hence the _cl suffix), so if you send a request for two countries, you must also pass two values to the 'year' argument, two values to the 'povline' argument, etc.

Usage

povcalnet_cl(
  country,
  povline,
  year,
  coverage = NULL,
  ppp = NULL,
  server = NULL,
  format = "csv"
)

Arguments

country	character: list of country iso3 code (accepts multiple). Use povcalnet_info for full list of countries.
povline	numeric: poverty line (in 2011 PPP-adjusted USD) to calculate poverty measures
year	numeric: list of years, or 'all', or 'last'.
coverage	character: Can take one of three values: 'national', 'urban', 'rural'
ppp	numeric: Optional - Allows the selection of custom PPP (Purchasing Power Parity) exchange rates
server	character: Key for API root URL. For testing purposes only, should not be changed for 99 percent of users.
format	character: Response format to be requested from the API: 'csv' or 'json'

Value

data.frame

Examples

povcalnet_cl(country = c("ALB", "USA"), povline = c(3.2, 5.5), year = c(2012, 2010))

worldbank/povcalnetR documentation built on Jan. 31, 2023, 4:30 a.m.