removeLink: Remove a link between two areas

View source: R/removeLink.R

removeLinkR Documentation

Description

Antares API OK

Remove a link between two areas in an Antares study.

Usage

removeLink(from, to, opts = antaresRead::simOptions())

Arguments

from, to

The two areas linked together.

opts

List of simulation parameters returned by the function antaresRead::setSimulationPath()

Value

An updated list containing various information about the simulation.

Examples

## Not run: 
createLink(from = "myarea", to  = "myarea2")
removeLink(from = "myarea", to  = "myarea2")

## End(Not run)

rte-antares-rpackage/antaresEditObject documentation built on Feb. 19, 2025, 6:47 p.m.