get_physical_flows: Retrieve physical flows data

Description Usage Arguments Value Examples

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

Description

Data about physical cross-border schedules detailing electricity flows actually transiting across the interconnection lines directly linking countries.

Usage

1
2
3
4
5
6
7
get_physical_flows(
  code_eic = NULL,
  start_date = NULL,
  end_date = NULL,
  token = NULL,
  raw = FALSE
)

Arguments

code_eic

Optional, EIC code of the desired country.

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
## 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 flow data
phys_flow <- get_physical_flows(token = token)


## End(Not run)

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