build_query_string_qp: build_query_string_qp Create simplified povcalnet_qp query...

View source: R/build_query_string_qp.R

build_query_string_qpR Documentation

build_query_string_qp Create simplified povcalnet_qp query string

Description

build_query_string_qp Create simplified povcalnet_qp query string

Usage

build_query_string_qp(
  country,
  popshare,
  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

popshare

numeric: Percentage of the population who live below the poverty line

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


build_query_string_qp(country = c("ALB", "CHN"),
popshare = .5,
year = c(2002, 2012))

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