editArea {antaresEditObject} | R Documentation |
Edit an area in an Antares study
Description
Edit an existing area in an Antares study.
Usage
editArea(
name,
color = NULL,
localization = NULL,
nodalOptimization = NULL,
filtering = NULL,
adequacy = NULL,
opts = antaresRead::simOptions()
)
Arguments
name |
Name of the area as a character, without punctuation except - and _. |
color |
Color of the node |
localization |
Localization on the map |
nodalOptimization |
Nodal optimization parameters, see |
filtering |
Filtering parameters, see |
adequacy |
Adequacy parameters, see |
opts |
List of simulation parameters returned by the function
|
Value
An updated list containing various information about the simulation.
See Also
Examples
## Not run:
library(antaresRead)
# Set simulation path
setSimulationPath(path = "PATH/TO/SIMULATION", simulation = "input")
# Edit an existing area
editArea("area", color = grDevices::rgb(230, 108, 44, max = 255),
localization = c(1, 1),
opts = antaresRead::simOptions())
editArea("de", nodalOptimization = list("spilledenergycost" = list(fr = 30)),
opts = antaresRead::simOptions())
editArea("de", nodalOptimization = nodalOptimizationOptions(),
opts = antaresRead::simOptions())
## End(Not run)
[Package antaresEditObject version 0.6.1 Index]