povcalnet: povcalnet Facilitate interaction with the PovcalNet API

Description Usage Arguments Value Examples

View source: R/povcalnet.R

Description

povcalnet Facilitate interaction with the PovcalNet API

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
povcalnet(
  country = "all",
  povline = 1.9,
  year = "all",
  aggregate = FALSE,
  fill_gaps = FALSE,
  coverage = "all",
  ppp = NULL,
  url = "http://iresearch.worldbank.org",
  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

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

url

character: 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

1
povcalnet(country = "ALB")

povcalnetR documentation built on July 8, 2020, 6:48 p.m.