loadFactor: Load factors of clusters
In antaresProcessing: 'Antares' Results Processing

Description Usage Arguments Value Examples

This function computes the load factor and other related statistics for cluster of a study.

loadFactor(
  x,
  timeStep = "annual",
  synthesis = FALSE,
  clusterDesc = NULL,
  loadFactorAvailable = FALSE,
  opts = NULL
)

`x`	Object of class `antaresData` created with function `readAntares`. It must contain hourly detailed results for clusters and has to contain the columns `minGenModulation`.
`timeStep`	Desired time step for the result.
`synthesis`	If TRUE, average surpluses are returned. Else the function returns surpluses per Monte-Carlo scenario.
`clusterDesc`	A table created with the function `readClusterDesc`. If is this parameter is set to `NULL` (the default), then the function attempts to read the needed data in the same study as `x`.
`loadFactorAvailable`	Should loadFactorAvailable be added to the result?
`opts`	opts where clusterDesc will be read if null based on data

a data.table of class antaresDataTablecontaining the following columns:

`area`	Area name
`cluster`	Cluster name
`mcYear`	Only if `synthesis=FALSE`. Id of the Monte-carlo scenario
`timeId`	Time id and other time variables
`loadFactor`	Load factor of the cluster. It represent the proportion of the installed capacity of a cluster that is effectively generate Formula: production / (unitcount * nominalcapacity)

loadFactorAvailable

Load factor of the cluster. It represent the proportion of the capacity available of a cluster that is effectively generate

Formula: production / thermalAvailability

propHoursMinGen

Proportion of hours when production is positive and all units of a cluster are either off, either producing at their minimum. This situation occurs when units are kept producing above the optimal level to avoid future startup costs or to satisfy the constraints generated by parameters "Min. up Time" or "Min gen. modulation".

Formula: mean(1 if production > 0 and production = max(min.stable.power * unitcount, minGenModulation * nominalcapacity * unitcount) else 0)

propHoursMaxGen

Proportion of hours when all units started produce at their maximal capacity.

Formula: mean(1 if production > 0 and production = NODU * nominalcapacity * (1 - spinning / 100))

## Not run: 
# data required by the function
showAliases("loadfactor")

mydata <- readAntares(select = "loadfactor")
loadFactor(mydata, synthesis = TRUE)

## End(Not run)