---
title: "Introduction"
author: "Markus Virtanen"
date: "2022-02-01"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Introduction}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---




```r
library(finnishgrid)
```

Read basic API specification at https://data.fingrid.fi/en/pages/api.

Register free user account at https://data.fingrid.fi/open-data-forms/registration/.

Optional: add API key as your environment variable (~/.Renviron) 


```bash
FINGRID_OPENDATA_API_KEY=MY_SECRET_KEY_FROM_EMAIL
```

## Setting time range with UTC+2 offset for Finland, and API user key


```r
start_time = "2021-01-01T00:00:00+0200"
end_time = "2021-01-03T00:00:00+0200"
user_key = NA  # TODO: replace with right key or use .Renviron file
```

## Fetching data with helper functions

Let's get Finnish hourly electricity consumption and production time-series 
data for basic visualization.


```r
elec_cons <- electricity_consumption_FI_RTD(start_time = start_time, 
                                            end_time = end_time, 
                                            user_key = user_key)

elec_prod <- electricity_production_FI_RTD(start_time = start_time, 
                                           end_time = end_time, 
                                           user_key = user_key)

min_elec_cons <- min(elec_cons$value)  # consumption
max_elec_cons <- max(elec_cons$value)

min_elec_prod <- min(elec_prod$value)  # production
max_elec_prod <- max(elec_prod$value)

y_max <- max(max_elec_cons, max_elec_prod)
y_min <- min(min_elec_cons, min_elec_prod)
```

## Basic data visualization 


```r
plot(elec_cons$start_time, elec_cons$value, type = 'l',
     col = "green", ylim = c(y_min, y_max),
     ylab = "Produced/Consumed (MW)",
     xlab = "Time", main = "Electricity")
lines(elec_prod$start_time, elec_prod$value, type = 'l', col = "blue")
legend("topright", c("Cons", "Prod"), fill = c("green", "blue"))
```

![plot of chunk unnamed-chunk-5](unnamed-chunk-5-1.png)

## Get electricity consumption in Finland with get_data() function

API page: https://data.fingrid.fi/en/dataset/electricity-consumption-in-finland


```r
tmp <- get_data(api_number = 124,  # energy consumption
                start_time = start_time, 
                end_time = end_time, 
                user_key = NA)
summary(tmp)
#>    start_time                     end_time                       value             id     
#>  Min.   :2021-01-01 00:00:00   Min.   :2021-01-01 01:00:00   Min.   : 8972   Min.   :124  
#>  1st Qu.:2021-01-01 12:00:00   1st Qu.:2021-01-01 13:00:00   1st Qu.: 9309   1st Qu.:124  
#>  Median :2021-01-02 00:00:00   Median :2021-01-02 01:00:00   Median : 9861   Median :124  
#>  Mean   :2021-01-02 00:00:00   Mean   :2021-01-02 01:00:00   Mean   : 9856   Mean   :124  
#>  3rd Qu.:2021-01-02 12:00:00   3rd Qu.:2021-01-02 13:00:00   3rd Qu.:10318   3rd Qu.:124  
#>  Max.   :2021-01-03 00:00:00   Max.   :2021-01-03 01:00:00   Max.   :11018   Max.   :124
```