addLoadFactorLink: Load factors of link

In rte-antares-rpackage/antaresProcessing: 'Antares' Results Processing

Load factors of link

Description

This function computes the load factor of link and add it to an antaresData object.

Usage

addLoadFactorLink(x)

Arguments

x	Object of class antaresData created with function readAntares. It must contain the columns transCapacityDirect and transCapacityIndirect.

Value

addLoadFactorLink modifies its input by adding to it two columns:

loadFactor	Proportion of the installed capacity of a link that is effectively used: loadFactor = `FLOW LIN` / transCapacity Notice that loadFactor can be positive or negative according to the direction of the flow.
congestion	1 if the link is saturated (loadFactor = +/-1), 0 otherwise.

For convenience, the function invisibly returns the modified input.

Examples

## Not run: 
# Data required by the function
showAliases("loadFactorLink")

mydata <- readAntares(select = "loadFactorLink")
addLoadFactorLink(mydata)
names(mydata)

## End(Not run)

rte-antares-rpackage/antaresProcessing documentation built on June 30, 2024, 2:28 a.m.