R/build_query_string_cl.R

In povcalnetR: Client for the 'Povcalnet' API

#' build_query_string_cl
#' Create povcalnet query string for country level, survey year specification
#'
#' @param country character: Requested country. Use \href{https://www.iban.com/country-codes}{iso3 codes }
#' @param povline numeric: Requested poverty lines in international dollars
#' @param year numeric: Requested survey years
#' @param ppp numeric: Optional - Custom PPP exchange rates (Purchasing Power parity)
#' @param coverage_type character: Optional - Type of data coverage. Take one to the following values
#' rural; urban; national; special_cpi; aggregated_distribution, invalid_ppp
#' @param format character: Response format to be requested from the API:
#' `csv` or `json`
#'
#' @return character
#' @export
#'
#' @examples
#'
#' build_query_string_cl(country = c("ALB", "CHN"),
#' povline = c(1.9, 2.0),
#' year = c(2002, 2002))

build_query_string_cl <- function(country,
                                       povline,
                                       year,
                                       ppp = NULL,
                                       coverage_type = NULL,
                                       format = "json") {
  # CHECK inputs
  assertthat::assert_that(length(unique(purrr::map_int(list(country, povline, year), length))) == 1,
                          msg = "When parameter_specification = 'country_level',
                          please ensure that you submit the same number of:
                          country; povline; and year")
  assertthat::assert_that(is.null(ppp) | length(ppp) == length(country),
                          msg = "When using custom ppp, please ensure you submit
                          one ppp per country")
  assertthat::assert_that(is.null(coverage_type) | length(coverage_type) == length(country),
                          msg = "When using custom ppp, please ensure you submit
                          one coverage_type per country")


  i <- seq_along(country) - 1

  if (!is.null(coverage_type)) {
    coverage_type <- unname(coverage_lkup[coverage_type])
    country <- paste(country, coverage_type, sep = "_")
  }

  country <- purrr::map2_chr(i, country, function(x, y) {paste0("C", x, "=", y)})
  povline <- purrr::map2_chr(i, povline, function(x, y) {paste0("PL", x, "=", y)})
  year <- purrr::map2_chr(i, year, function(x, y) {paste0("Y", x, "=", y)})
  format <- paste0("format=", format)

  if (!is.null(ppp)) {
    ppp <- purrr::map2_chr(i, ppp, function(x, y) {paste0("PPP", x, "=", y)})
    out <- paste(country, povline, year, ppp, collapse = "&")
    out <- stringr::str_replace_all(out, pattern = " ", replacement = "&")
  } else {
    out <- paste(country, povline, year, collapse = "&")
    out <- stringr::str_replace_all(out, pattern = " ", replacement = "&")
  }

  out <- paste(out, format, sep = "&")

  return(out)
}