outages_gen_units: Get Unavailability of Generation Units. (15.1.A&B)

View source: R/en_outages.R

outages_gen_unitsR Documentation

Get Unavailability of Generation Units. (15.1.A&B)

Description

The planned and forced unavailability of generation units expected to last at least one market time unit up to 3 years ahead. The "available capacity during the event" means the minimum available generation capacity during the period specified.

Usage

outages_gen_units(
  eic = NULL,
  period_start = lubridate::ymd(Sys.Date() + lubridate::days(x = 1L), tz = "CET"),
  period_end = lubridate::ymd(Sys.Date() + lubridate::days(x = 2L), tz = "CET"),
  period_start_update = NULL,
  period_end_update = NULL,
  doc_status = NULL,
  event_nature = NULL,
  tidy_output = TRUE,
  security_token = Sys.getenv("ENTSOE_PAT")
)

Arguments

eic

Energy Identification Code of the bidding zone/ control area (To extract outages of bidding zone DE-AT-LU area, it is recommended to send queries per control area i.e. CTA|DE(50Hertz), CTA|DE(Amprion), CTA|DE(TeneTGer),CTA|DE(TransnetBW), CTA|AT,CTA|LU but not per bidding zone.)

period_start

the starting date of the in-scope period in POSIXct or YYYY-MM-DD HH:MM:SS format

period_end

the ending date of the outage in-scope period in POSIXct or YYYY-MM-DD HH:MM:SS format

period_start_update

notification submission/update starting date in POSIXct or YYYY-MM-DD HH:MM:SS format

period_end_update

notification submission/update ending date in POSIXct or YYYY-MM-DD HH:MM:SS format

doc_status

Notification document status. "A05" for active, "A09" for cancelled and "A13" for withdrawn. Defaults to NULL which means "A05" and "A09" together.

event_nature

"A53" for planned maintenance. "A54" for unplanned outage. Defaults to NULL which means both of them.

tidy_output

Defaults to TRUE. flatten nested tables

security_token

Security token for ENTSO-E transparency platform

Examples

df <- entsoeapi::outages_gen_units(
  eic                 = "10YFR-RTE------C",
  period_start        = lubridate::ymd(x = Sys.Date() +
                                         lubridate::days(x = 1L),
                                       tz = "CET"),
  period_end          = lubridate::ymd(x = Sys.Date() +
                                         lubridate::days(x = 2L),
                                       tz = "CET"),
  period_start_update = lubridate::ymd(x = Sys.Date() -
                                         lubridate::days(x = 7L),
                                       tz = "CET"),
  period_end_update   = lubridate::ymd(x = Sys.Date(),
                                       tz = "CET")
)

str(df)


krose/entsoeapi documentation built on Jan. 13, 2025, 9:01 p.m.