electricity_wind_pwr_total_cap {finnishgrid}R Documentation

Total production capacity used in the wind power forecast

Description

This is the total wind production capacity used in Fingrid's wind power forecast. It is based capacity information gathered by Fingrid.This total capacity information can be used, for example, to calculate the rate of production of wind power, by comparing it to the actual wind production series by Fingrid. This capacity information cannot however be considered as the official amount of wind production capacity in Finland, as it is updated manually.

Usage

electricity_wind_pwr_total_cap(
  start_time_utc = NA,
  end_time_utc = NA,
  user_key = NA
)

Arguments

start_time_utc

Start time in UTC. Character array YYYY-MM-ddTHH:mm:ss.sssZ

end_time_utc

End time in UTC. Character array YYYY-MM-ddTHH:mm:ss.sssZ

user_key

Character array holding API-key. Free from https://data.fingrid.fi/en/instructions

Value

A data frame object with time series data having period 1 h and unit type 1 MW.

See Also

https://data.fingrid.fi/en/datasets/268

Examples

## Not run: 
library(finnishgrid)
start = "2024-06-01T00:00:00.000Z"  # UTC
end = "2024-06-03T00:00:00.000Z"    # UTC
key = "MY_SUPER_SECRET"
df <- electricity_wind_pwr_total_cap(start_time_utc = start,
         end_time_utc = end,
         user_key = key)
summary(df)

## End(Not run)

[Package finnishgrid version 0.2.0 Index]