specify input options explicity and use match.arg to check

R/construct_query_url.R

@@ -8,14 +8,18 @@
 #' @returns query_url API query URL for specified parameters
 #' @export
 #'
-construct_query_url <- function(endpoint = "electricity-generation",
-                                temporal_resolution = "yearly",
+construct_query_url <- function(endpoint = c("electricity-generation", "power-sector-emissions", "electricity-demand", "carbon-intensity"),
+                                temporal_resolution = c("yearly", "monthly"),
                                 min_date = "2015",
                                 max_date = "2023",
                                 entity = "all",
                                 api_key = Sys.getenv("EMBER_API_KEY")) {
   base_url <- "https://api.ember-climate.org/v1/"
 
+  # check inputs
+  endpoint <- match.arg(endpoint)
+  temporal_resolution <- match.arg(temporal_resolution)
+
   if (entity == "all") {
     entity_str <- ""
   } else {

R/get_electricity_generation.R

@@ -8,12 +8,15 @@
 #' @export
 #' @seealso [get_ember_options()]
 
-get_electricity_generation <- function(temporal_resolution = "yearly",
+get_electricity_generation <- function(temporal_resolution = c("yearly", "monthly"),
                                        min_date = "2015",
                                        max_date = "2023",
                                        entity = "all",
                                        api_key = Sys.getenv("EMBER_API_KEY")) {
 
+  # check input
+  temporal_resolution <- match.arg(temporal_resolution)
+
   df <- get_ember_data(dataset = "electricity-generation", temporal_resolution, min_date, max_date, entity, api_key)
 
   return(df)

R/get_ember_data.R

@@ -9,13 +9,17 @@
 #' @export
 #' @seealso [get_ember_options()]
 
-get_ember_data <- function(dataset = "electricity-generation",
-                                       temporal_resolution = "yearly",
+get_ember_data <- function(dataset = c("electricity-generation", "power-sector-emissions", "electricity-demand", "carbon-intensity"),
+                                       temporal_resolution = c("yearly", "monthly"),
                                        min_date = "2015",
                                        max_date = "2023",
                                        entity = "all",
                                        api_key = Sys.getenv("EMBER_API_KEY")) {
 
+  # check inputs
+  dataset <- match.arg(dataset)
+  temporal_resolution <- match.arg(temporal_resolution)
+
   query_url <- construct_query_url(endpoint = dataset,
                                    temporal_resolution = temporal_resolution,
                                    min_date = min_date,

R/get_ember_options.R

@@ -1,18 +1,21 @@
 #' Get API parameter options for Ember dataset
 #' @param dataset Default="electricity-generation"
 #' @param temporal_resolution default ="yearly"
-#' @param filter_name Parameter to get options for (ex: entity, series, date. Default = "entity"
+#' @param filter_name Parameter to get options for (ex: entity, series, date. Default = "entity")
 #' @param api_key Default is Sys.getenv("EMBER_API_KEY")
 #' @returns options List of options for specified parameter
 #' @export
 
-get_ember_options <- function(dataset = "electricity-generation",
-                              temporal_resolution = "yearly",
+get_ember_options <- function(dataset = c("electricity-generation", "power-sector-emissions", "electricity-demand", "carbon-intensity"),
+                              temporal_resolution = c("yearly", "monthly"),
                               filter_name = "entity",
                               api_key = Sys.getenv("EMBER_API_KEY")){
 
-  base_url <- "https://api.ember-climate.org/v1/options/"
+  # check inputs
+  dataset <- match.arg(dataset)
+  temporal_resolution <- match.arg(temporal_resolution)
 
+  base_url <- "https://api.ember-climate.org/v1/options/"
 
   query_url <- paste0(base_url, dataset, "/", temporal_resolution, "/", filter_name, "?api_key=", api_key)