R/check_params.R

In datazoompuc/datazoom.amazonia: Simplify Access to Data from the Amazon Region

check_params <- function(param) {
  ###########################
  ## Bind Global Variables ##
  ###########################

  survey <- dataset <- available_time <- available_geo <- . <- NULL

  ###################
  ## Dataset check ##
  ###################

  if (is.numeric(param$dataset)) {
    return(invisible(NULL))
  } # edge case for numeric datasets,
  # which aren't listed in datasets_link

  # extracting the supported datasets from datasets_link

  supp_datasets <- datasets_link(source = param$source) %>%
    purrr::pluck("dataset") # vector with all possible datasets

  if (!(param$dataset %in% supp_datasets)) {
    dataset_error <- paste(
      "Dataset", param$dataset, "not supported.",
      "Dataset must be one of:", "\n", paste(supp_datasets, collapse = "\n")
    )

    stop(dataset_error)
  }

  #######################
  ## Time period check ##
  #######################

  if (!is.null(param$time_period)) {
    # constructing vector of supported years

    supp_time_period_str <- datasets_link(source = param$source, dataset = param$dataset) %>%
      purrr::pluck("available_time")

    # separating by commas: 2003, 2007, 2014 -> c(2003, 2007, 2014)

    supp_time_period <- supp_time_period_str %>%
      stringr::str_split(",", simplify = TRUE)

    # separating by hyphens: 2003 - 2007 -> 2003:2007

    supp_time_period <- supp_time_period %>%
      purrr::map(
        function(str) {
          str %>%
            stringr::str_replace("-", ":") %>%
            parse(text = .) %>%
            eval()
        }
      ) %>%
      unlist()


    if (!all(param$time_period %in% supp_time_period)) {
      time_period_error <- paste("Option time_period must be in", supp_time_period_str)

      stop(time_period_error)
    }
  }

  #####################
  ## Geo level check ##
  #####################

  if (!(is.null(param$geo_level))) {
    # constructing vector of supported geo_levels

    supp_geo_level_str <- datasets_link(source = param$source, dataset = param$dataset) %>%
      purrr::pluck("available_geo") %>%
      tolower()

    supp_geo_level <- supp_geo_level_str %>%
      stringr::str_split(",", simplify = TRUE) %>%
      stringr::str_trim()

    if (!(param$geo_level %in% supp_geo_level)) {
      geo_level_error <- paste("Option geo_level must be one of", supp_geo_level_str)

      if (!any(is.na(supp_geo_level))) stop(geo_level_error)
      # edge case for when geo_level exists for only some datasets.
      # for the datasets without geo_level, avaliable_geo should be NA
      # if avaliable_geo is NA, then any geo_level works
    }
  }
}