R/dst_query_match.R

In rOpenGov/dkstat: API connection to the StatBank from Statistics Denmark

#' Helper function to return ids based on text values
#'
#' This is a helper function to return the ids based on the text values.
#' @param table Table from StatBank.
#' @param lang language. "en" for english and "da" for danish.
#' @param meta_data A meta data object to extract values from
#' @param query query to match against
#' @param format Format to specify match for csv import (not used)
#'
#' @noRd
dst_query_match <- function(table, lang, meta_data, query, format) {
  # if no meta data is supplied we download this to match the request.
  if (is.null(meta_data)) {
    meta_data <- dst_meta(table = table, lang = lang)
  }

  # I create a new list for the ids
  matched_query <- vector(mode = "list", length = length(query))
  names(matched_query) <- names(query)

  # Stop the function if the query variable names dosn't match the meta data
  # names. Check if all names in the query by matching it with the possible
  # names in the meta data
  if (!(all(names(query) %in% toupper(names(meta_data$values))))) {
    stop(paste0(
      "All the variable names in your query couldn't be matched to the meta data.\n" # nolint
    ))
  }

  # Loop over query and match the text with the ids and then return the IDs.
  # The id's are used to query the API so we need to replace the text
  # with the ID.

  # the * is a "get all variables" replacement.
  for (i in seq_along(query)) {
    if (query[[i]][1] != "*") {
      matched_query[[i]] <- dst_find_val_id(
        meta_data = meta_data,
        variable = names(query)[i],
        values_text = query[[i]]
      )
    } else {
      matched_query[[i]] <- "*"
    }
  }

  # nolint start
  # Make sure that the user hasn't eliminated some of the mandatory variable IDs
  # I mathc the names of the IDs in the meta data where the elimination == FALSE
  if (!all(toupper(meta_data$variables$id[meta_data$variables$elimination == FALSE]) %in% toupper(names(query)))) {
    stop("Not all the mandatory variables are present in your query.")
  }
  # nolint end

  return(matched_query)
}