Skip to content

Commit 08f0435

Browse files
document year parameter in load_aneel
Add roxygen documentation for the new year parameter in load_aneel. Clarify that it is required for energy_development_budget and ignored for other datasets. Update examples to include the new usag
1 parent 72ae600 commit 08f0435

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

R/aneel.R

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
#' @description National Electric Energy Agency - ANEEL
44
#'
55
#' @param dataset A dataset name ("energy_development_budget", "energy_generation" or "energy_enterprises_distributed")
6+
#' @param year A numeric value or vector of years (2017-2022).
7+
#' Required for the "energy_development_budget" dataset.
8+
#' Ignored for the other datasets.
69
#' @inheritParams load_baci
710
#'
811
#' @examples
@@ -12,6 +15,13 @@
1215
#' dataset = "energy_generation",
1316
#' raw_data = FALSE
1417
#' )
18+
#'
19+
#' # download raw annual CDE budget data
20+
#' raw_cde <- load_aneel(
21+
#' dataset = "energy_development_budget",
22+
#' year = 2021,
23+
#' raw_data = TRUE
24+
#' )
1525
#' }
1626
#'
1727
#' @export
@@ -42,7 +52,7 @@ load_aneel <- function(dataset,
4252
if (param$dataset == "energy_development_budget" && is.null(param$year)) {
4353
stop("For 'energy_development_budget', you must provide 'year'.")
4454
}
45-
55+
4656
if (param$dataset == "energy_generation") {
4757
skip <- 1
4858
# skips first row of excel sheet for this dataset
@@ -64,11 +74,11 @@ load_aneel <- function(dataset,
6474
year = y,
6575
skip_rows = skip
6676
)
67-
77+
6878
if (!"year" %in% names(df_y)) {
6979
df_y$year <- y
7080
}
71-
81+
7282
df_y
7383
})
7484
} else {
@@ -79,11 +89,11 @@ load_aneel <- function(dataset,
7989
skip_rows = skip
8090
)
8191
}
82-
92+
8393
if (param$raw_data) {
8494
return(dat)
8595
}
86-
96+
8797

8898
######################
8999
## Data Engineering ##

0 commit comments

Comments
 (0)