build_query_string: build_query_string Create simplified povcalnet query string

Description Usage Arguments Value Examples

View source: R/build_query_string.R

Description

build_query_string Create simplified povcalnet query string

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
build_query_string(
  country,
  povline,
  year,
  aggregate = FALSE,
  fill_gaps = FALSE,
  coverage = "all",
  ppp = NULL,
  format = "json"
)

Arguments

country

character: list of country iso3 code (accepts multiple) or 'all'. Use iso3 codes

povline

numeric: poverty line (in 2011 PPP-adjusted USD) to calculate poverty measures

year

numeric: list of years, or 'all', or 'last'.

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 four values: 'all' (default), 'national', 'urban', 'rural'.

ppp

numeric: Optional - Allows the selection of custom PPP (Purchasing Power Parity) exchange rates

format

character: Response format to be requested from the API: 'csv' or 'json'

Value

character

Examples

1
2
3
build_query_string(country = c("ALB", "CHN"),
povline = 1.9,
year = c(2002, 2012))

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