get_ntc: Retrieve NTC data via RTE data API

In rte-antares-rpackage/antaresWeeklyMargin: Setup an 'Antares' Study for Weekly Margin Simulation

Description

Retrieve NTC data via RTE data API

Usage

get_ntc(token, type = c("ANNUAL", "MONTHLY", "WEEKLY", "D-1",
  "CURTAILED"), start_date = NULL, end_date = NULL,
  country_eic_code = NULL, user = NULL, proxy_pwd = NULL)

Arguments

token	Token obtained with get_token.
type	NTC due type, mandatory, one or several between 'ANNUAL', 'MONTHLY', 'WEEKLY', 'D-1', 'CURTAILED'.
start_date	Optional, starting date to filter results, if used, end_date must be set as well.
end_date	Optional, ending date to filter results.
country_eic_code	Country code.
user	Username (NNI) for proxy if needeed.
proxy_pwd	Password for proxy if needeed.

Value

a data.table.

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 NTC data
ntc <- get_ntc(token = token, type = c("ANNUAL", "MONTHLY"))


## End(Not run)

rte-antares-rpackage/antaresWeeklyMargin documentation built on July 25, 2019, 8:23 p.m.