R/glm_variables.R

In ropenmeteo: Wrappers for 'Open-Meteo' API

#' Get set of variables required for the GLM model

#' @param product api type: climate, forecast, ensemble_forecast, historical, seasonal_forecast
#' @param time_step model and time-step: hourly, 6hour, daily
#'
#' @returns a vector of variables requires by the GLM model; the vector can be used in the `variables` argument in the API function calls (e.g., `get_ensemble_forecast`).
#' @export
#'
#' @examples
#' glm_variables(product = "ensemble_forecast", time_step = "hourly")
#'

glm_variables <- function(product, time_step){

  product_time_step <- paste0(product, "_", time_step)

  if(product_time_step %in% c("ensemble_forecast_hourly",
                              "forecast_hourly",
                              "historical_hourly")){

    glm_vars <- c("relative_humidity_2m",
      "precipitation",
      "wind_speed_10m",
      "cloud_cover",
      "temperature_2m",
      "shortwave_radiation",
      "surface_pressure")

    return(glm_vars)

    }else if(product_time_step %in% c("seasonal_forecast_6hourly")){

      glm_vars <- c("relative_humidity_2m",
                    "precipitation",
                    "wind_speed_10m",
                    "cloud_cover",
                    "temperature_2m",
                    "shortwave_radiation")

      return(glm_vars)

    }else if(product_time_step == "climate_projection_daily"){

      glm_vars <- c("temperature_2m_mean",
                    "wind_speed_10m_mean",
                    "cloud_cover_mean",
                    "shortwave_radiation_sum",
                    "relative_humidity_2m_mean",
                    "precipitation_sum")

    }else{
      stop(paste0(paste0(product, " ", time_step) ," GLM variables not supported yet"))

    }

}