povcalnet: povcalnet Facilitate interaction with the PovcalNet API

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

povcalnet Facilitate interaction with the PovcalNet API

Description

povcalnet Facilitate interaction with the PovcalNet API

Usage

povcalnet(
  country = "all",
  povline = NULL,
  popshare = NULL,
  year = "all",
  aggregate = FALSE,
  fill_gaps = FALSE,
  coverage = "all",
  ppp = NULL,
  server = NULL,
  format = "csv"
)

Arguments

country	character: list of country iso3 code (accepts multiple) or 'all'. Use povcalnet_info for full list of countries.
povline	numeric: poverty line (in 2011 PPP-adjusted USD) to calculate poverty measures
popshare	numeric: Share of population to calculate poverty line
year	numeric: list of years, or 'all'.
aggregate	logical: 'TRUE' will return aggregate results, 'FALSE' country-level results.
fill_gaps	logical: 'TRUE' will interpolate / extrapolate values when surveys are not available for a specific year.
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(country = "ALB")

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