editArea: Edit an area in an Antares study

In antaresEditObject: Edit an 'Antares' Simulation

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 nodalOptimizationOptions().
filtering	Filtering parameters, see filteringOptions().
adequacy	Adequacy parameters, see adequacyOptions().
opts	List of simulation parameters returned by the function antaresRead::setSimulationPath()

Value

An updated list containing various information about the simulation.

See Also

createArea(), removeArea()

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)

antaresEditObject documentation built on Dec. 6, 2022, 5:10 p.m.