electricity_consumption_forecast_hourly_updated: Electricity consumption forecast of Finland. Forecast is...

View source: R/finnishgrid.R

electricity_consumption_forecast_hourly_updatedR Documentation

Electricity consumption forecast of Finland. Forecast is updated hourly

Description

Check https://data.fingrid.fi/en/dataset/updated-electricity-consumption-forecast-of-finland

Usage

electricity_consumption_forecast_hourly_updated(
  start_time = NA,
  end_time = NA,
  user_key = NA
)

Arguments

start_time

Start time in UTC with offset. Character array in ISO8601, YYYY-MM-ddTHH:mm:ssZ

end_time

End time in UTC with offset. Character array in ISO8601, YYYY-MM-ddTHH:mm:ssZ

user_key

Character array holding API-key. Free from https://data.fingrid.fi/open-data-forms/registration/

Value

A data frame object that contains electricity consumption forecast of Finland. The forecast is made by Fingrid and updated hourly.

Examples

## Not run: 
library(finnishgrid)
start = "2021-01-01T00:00:00+0200"  # UTC+2 offset, Helsinki time
end = "2021-01-10T00:00:00+0200"    # UTC+2 offset, Helsinki time
key = "MY_SUPER_SECRET"
df <- electricity_consumption_forecast_hourly_updated(
    start_time = start,
    end_time = end,
    user_key = key)
summary(df)

## End(Not run)

finnishgrid documentation built on March 18, 2022, 7:23 p.m.