get_actual_generation: Retrieve actual generation data

Description Usage Arguments Value Examples

View source: R/open-api-helpers.R

Description

Production data aggregated by sector and group (in MW) on an intraday basis, corresponding to net production injected into the network.

Usage

1
2
3
4
5
6
7
8
get_actual_generation(
  resource = c("actual_generations_per_production_type", "actual_generations_per_unit",
    "water_reserves", "generation_mix_15min_time_scale"),
  start_date = NULL,
  end_date = NULL,
  token = NULL,
  raw = FALSE
)

Arguments

resource

Which ressource to use between actual_generations_per_production_type (production data aggregated by branch), actual_generations_per_unit (production data realised by group), water_reserves (hydraulic stock data) and generation_mix_15min_time_scale (production data realized from the global energy mix).

start_date

Optional, starting date to filter results.

end_date

Optional, ending date to filter results.

token

Token obtained with get_token.

raw

Return output from fromJSON.

Value

a data.table or a list if raw = TRUE.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
## Not run: 

# First you need a token
id_client <- "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"
id_secret <- "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX"
token <- get_token(
  key = list(id_client = id_client, id_secret = id_secret)
)

# Then you can retrieve consumption data
per_prod_type <- get_actual_generation(
  "actual_generations_per_production_type", token = token
)


## End(Not run)

dreamRs/rte.data documentation built on April 4, 2020, 8:12 p.m.