get_consumption: Retrieve consumption data

In dreamRs/rte.data: Access RTE Data API

Retrieve consumption data

Description

Data on French electricity consumption in real time. Forecasts are also available, they include electricity losses on the grid but do not include pumping consumption of waterworks.

Usage

get_consumption(
  resource = c("short_term", "weekly_forecasts", "annual_forecasts"),
  type = c("REALISED", "ID", "D-1", "D-2"),
  start_date = NULL,
  end_date = NULL,
  token = NULL,
  raw = FALSE
)

Arguments

resource	Which ressource to use between short_term (short-term consumption forecasts), weekly_forecast (weekly consumption forecasts) and annual_forecast (annual consumption forecasts).
type	Forecast type of consumption, one or several between 'REALISED', 'ID', 'D-1', 'D-2'.
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

## 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
consumption <- get_consumption("short_term", token = token)


## End(Not run)

dreamRs/rte.data documentation built on Oct. 6, 2022, 6:32 p.m.