add option to specify single year

R/construct_query_url.R

@@ -1,6 +1,7 @@
 #' Construct query URL for Ember data API
 #' @param endpoint Default = "electricity-generation"
 #' @param temporal_resolution "yearly" (default) or "monthly"
+#' @param year (optional) If specified, retrieve data for a single year
 #' @param min_date Mininum date to retrieve data for. YYYY or YYYY-MM format. Default=2015
 #' @param max_date Maximum date to retrieve data for. YYYY or YYYY-MM format. Default=2023
 #' @param entity List of comma-separated country(s) or region(s) to return data for. Default is all (no filter)
@@ -10,6 +11,7 @@
 #'
 construct_query_url <- function(endpoint = c("electricity-generation", "power-sector-emissions", "electricity-demand", "carbon-intensity"),
                                 temporal_resolution = c("yearly", "monthly"),
+                                year = NA,
                                 min_date = "2015",
                                 max_date = "2023",
                                 entity = "all",
@@ -20,6 +22,17 @@ construct_query_url <- function(endpoint = c("electricity-generation", "power-se
   endpoint <- match.arg(endpoint)
   temporal_resolution <- match.arg(temporal_resolution)
 
+  # if year supplied, use that
+  if (!is.na(year)) {
+    if (temporal_resolution == "yearly") {
+      min_date <- year
+      max_date <- year
+    } else {
+      min_date <- year
+      max_date <- year + 1
+    }
+  }
+
   if (entity == "all") {
     entity_str <- ""
   } else {

R/get_electricity_generation.R

@@ -1,5 +1,6 @@
 #' Get Ember electricity-generation data from API
 #' @param temporal_resolution "yearly" (default) or "monthly"
+#' @param year (optional) If specified, retrieve data for a single year
 #' @param min_date Mininum date to retrieve data for. YYYY or YYYY-MM format. Default=2015
 #' @param max_date Maximum date to retrieve data for. YYYY or YYYY-MM format. Default=2023
 #' @param entity List of comma-separated country(s) or region(s) to return data for. Default is all (no filter)
@@ -9,6 +10,7 @@
 #' @seealso [get_ember_options()]
 
 get_electricity_generation <- function(temporal_resolution = c("yearly", "monthly"),
+                                       year = NA,
                                        min_date = "2015",
                                        max_date = "2023",
                                        entity = "all",
@@ -17,7 +19,7 @@ get_electricity_generation <- function(temporal_resolution = c("yearly", "monthl
   # check input
   temporal_resolution <- match.arg(temporal_resolution)
 
-  df <- get_ember_data(dataset = "electricity-generation", temporal_resolution, min_date, max_date, entity, api_key)
+  df <- get_ember_data(dataset = "electricity-generation", temporal_resolution, year, min_date, max_date, entity, api_key)
 
   return(df)
 }

R/get_ember_data.R

@@ -1,6 +1,7 @@
 #' Get Ember-climate data from API
 #' @param dataset Dataset to retrieve. Default = "electricity-generation". Other options are "power-sector-emissions", "electricity-demand", and "carbon-intensity"
 #' @param temporal_resolution "yearly" (default) or "monthly"
+#' @param year (optional) If specified, retrieve data for a single year
 #' @param min_date Minimum date to retrieve data for. YYYY or YYYY-MM format. Default=2015
 #' @param max_date Maximum date to retrieve data for. YYYY or YYYY-MM format. Default=2023
 #' @param entity List of comma-separated country(s) or region(s) to return data for. Default is all (no filter)
@@ -11,6 +12,7 @@
 
 get_ember_data <- function(dataset = c("electricity-generation", "power-sector-emissions", "electricity-demand", "carbon-intensity"),
                                        temporal_resolution = c("yearly", "monthly"),
+                                       year = NA,
                                        min_date = "2015",
                                        max_date = "2023",
                                        entity = "all",
@@ -22,6 +24,7 @@ get_ember_data <- function(dataset = c("electricity-generation", "power-sector-e
 
   query_url <- construct_query_url(endpoint = dataset,
                                    temporal_resolution = temporal_resolution,
+                                   year = year,
                                    min_date = min_date,
                                    max_date = max_date,
                                    entity = entity,