propertiesLinkOptions: Properties for creating a link

In antaresEditObject: Edit an 'Antares' Simulation

Properties for creating a link

Description

Properties for creating a link

Usage

propertiesLinkOptions(
  hurdles_cost = FALSE,
  transmission_capacities = "enabled",
  asset_type = "ac",
  display_comments = TRUE,
  filter_synthesis = c("hourly", "daily", "weekly", "monthly", "annual"),
  filter_year_by_year = c("hourly", "daily", "weekly", "monthly", "annual")
)

Arguments

hurdles_cost	Logical, which is used to state whether (linear) transmission fees should be taken into account or not in economy and adequacy simulations
transmission_capacities	Character, one of enabled, ignore or infinite, which is used to state whether the capacities to consider are those indicated in 8760-hour arrays or if zero or infinite values should be used instead (actual values / set to zero / set to infinite)
asset_type	Character, one of ac, dc, gas, virt or other. Used to state whether the link is either an AC component (subject to Kirchhoff’s laws), a DC component, or another type of asset.
display_comments	Logical, display comments or not.
filter_synthesis	Output synthesis.
filter_year_by_year	Output year-by-year.

Value

A named list that can be used in createLink().

Examples

propertiesLinkOptions(hurdles_cost = TRUE)

antaresEditObject documentation built on Oct. 4, 2023, 1:06 a.m.