gie (version 0.1.2)

gie_unav: gie_unav -- Download info on unavailabilities

Description

Function to download data on AGSI+ and ALSI+ unavailability

Usage

gie_unav(
  country = NULL,
  start = NULL,
  end = NULL,
  type = NULL,
  end_flag = NULL,
  timeout = 3,
  size = 30,
  database = "agsi",
  apikey = Sys.getenv("GIE_APIKEY")
)

Value

A data.frame or list with the results.

Arguments

country

Character. Specify the country of interest as two-digit country code (e.g., 'DE', 'IE').

start

Character. Specify the start of the time span you are
interested in downloading (format: YYYY-MM-DD).

end

Character. Specify the end of the time span you are
interested in downloading (format: YYYY-MM-DD).

type

Character. The type of unavailability info you want (choose between 'planned' and 'unplanned').

end_flag

Character. The end flag for the unavailability info (choose between 'confirmed' and 'estimate').

timeout

Numeric. If the amount of pages of your request exceeds 60, a timeout
will be enforced to prevent the API from timing out. Defaults to 3 seconds, any
values must be set in seconds, too.

size

Integer. The number of results per page.

database

Character. The type of API you want to address ('agsi' or 'alsi').

apikey

Character. Your personal API key.

Examples

if (FALSE) {
gie_unav(country = "DE", date = "2022-01-03", database = "alsi")
}