addTypicalDayId: Add a flow-based typical day id column

Description Usage Arguments Examples

View source: R/addColumnTypicalDay.R

Description

Add to an Antares output table a column indicating the id of the used flow-based typical day for each timestep. This information is read in the "user" directory file of the Antares study: it must be made sure that the data of the study is still consistent with the output.

Usage

1
addTypicalDayId(data, fb_opts = antaresRead::simOptions())

Arguments

data

antaresdata output data load by readAntares

fb_opts

list of simulation parameters returned by the function setSimulationPath or fb model localisation obtain with setFlowbasedPath. The default value is indicated by antaresRead::simOptions().

Examples

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

antaresRead::setSimulationPath("D:/Users/titorobe/Desktop/antaresStudy", 1)
data <- readAntares(mcYears = 1:10)
data <- addTypicalDayId(data)


data <- readAntares(areas = "all", links = "all", clusters = "all" ,mcYears = 1:10)
data <- addTypicalDayId(data)


## End(Not run)

rte-antares-rpackage/antaresFlowbased documentation built on Oct. 19, 2020, 11:23 a.m.