createLink {antaresEditObject}R Documentation

Create a link between two areas

Description

Antares API OK

Create a new link between two areas in an Antares study.

Usage

createLink(
  from,
  to,
  propertiesLink = propertiesLinkOptions(),
  dataLink = NULL,
  tsLink = NULL,
  overwrite = FALSE,
  opts = antaresRead::simOptions()
)

Arguments

from, to

The two areas linked together.

propertiesLink

a named list containing the link properties, e.g. hurdles-cost or transmission-capacities for example. See propertiesLinkOptions().

dataLink

See Details section below.

tsLink

Transmission capacities time series. First N columns are direct TS, following N are indirect ones.

overwrite

Logical, overwrite the previous between the two areas if exist

opts

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

Details

The eight potential times-series are:

According to Antares version, usage may vary :

< v7.0.0 : 5 first columns are used in the following order: NTC direct, NTC indirect, Impedances, Hurdle cost direct, Hurdle cost indirect.

>= v7.0.0 : 8 columns in order above are expected.

>= v8.2.0 : there's 2 cases :

Value

An updated list containing various information about the simulation.

Note

In Antares, areas are sorted in alphabetical order to establish links between. For example, link between "fr" and "be" will appear under "be". So the areas are sorted before creating the link between them, and dataLink is rearranged to match the new order.

See Also

editLink(), removeLink()

Examples

## Not run: 

library(antaresRead)

# Set simulation path
setSimulationPath(path = "PATH/TO/SIMULATION", simulation = "input")

# Create a link between two areas
createLink(from = "first_area", to  = "second_area")


## End(Not run)

[Package antaresEditObject version 0.6.1 Index]