Skip to content

Commit 7d441b1

Browse files
update ANEEL vignette for new year parameter
Update ANEEL vignette to reflect the new year argument for energy_development_budget. Document the valid 2017-2022 range, clarify that year can be a single value or a vector, and fix ANEEL usage examples.
1 parent c19ddad commit 7d441b1

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

vignettes/ANEEL.Rmd

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ knitr::opts_chunk$set(
1616

1717
Loads data from the National Electrical Energy Agency (ANEEL), a Brazilian independent federal agency linked to the Ministry of Mines and Energy (MME). ANEEL works to provide favorable conditions for the Electrical Energy Market to develop with balance and for the benefit of society.
1818

19-
As for now, there are three different datasets available for download: the Energy Development Budget and the Energy Generation.
19+
As for now, there are three different datasets available for download: Energy Development Budget, Energy Generation, and Energy Enterprises Distributed.
2020

2121
#### Energy Development Budget
2222

23-
The Energy Development Budget dataset showcases the Energy Development Account's (CDE) anual budget expenses. The CDE is designed to promote the Brazilian energy development and is managed by the Electrical Energy Commercialization Chamber (CCEE).
23+
The Energy Development Budget dataset showcases the Energy Development Account's (CDE) annual budget expenses. The CDE is designed to promote the Brazilian energy development and is managed by the Electrical Energy Commercialization Chamber (CCEE).
2424

25-
The dataset makes available the year of the observation -- from 2013 to 2022 --, the type of expense, its value in R$ (Reais) and its share over the total amount of CDE budget expenses on the year\*.
25+
In the current implementation, data is available from 2017 to 2022 and must be downloaded by year. The year argument can be a single year or a vector of years.
26+
The dataset includes the type of expense, its value in R$ (Reais), and its share over the total amount of CDE budget expenses in each year.\*.
2627

2728
\*Note that 'share_of_total' values sum to 1 for each year available.
2829

@@ -55,6 +56,10 @@ The data is expressed in quantities and installed power in kW (kilowatt). The qu
5556
* `FALSE`: if you want the treated version of the data.
5657

5758
3. **language**: you can choose between Portuguese `("pt")` and English `("eng")`
59+
4. **year**: only used for "energy_development_budget".
60+
It can be a single year or a vector of years from 2017:2022.
61+
This argument is required for "energy_development_budget" and can be
62+
omitted for the other datasets.
5863

5964
***
6065

@@ -63,7 +68,22 @@ The data is expressed in quantities and installed power in kW (kilowatt). The qu
6368
```{r eval=FALSE}
6469
# download treated data about energy generation
6570
clean_aneel <- load_aneel(
66-
dataset = "energy generation",
71+
dataset = "energy_generation",
6772
raw_data = FALSE
6873
)
74+
75+
76+
# download raw CDE data for one year
77+
budget_aneel_2019 <- load_aneel(
78+
dataset = "energy_development_budget",
79+
raw_data = TRUE,
80+
year = 2019
81+
)
82+
83+
# download raw CDE data for multiple years
84+
budget_aneel_multi <- load_aneel(
85+
dataset = "energy_development_budget",
86+
raw_data = TRUE,
87+
year = c(2020, 2021)
88+
)
6989
```

0 commit comments

Comments
 (0)