netLoadRamp: Ramp of an area
In antaresProcessing: 'Antares' Results Processing

netLoadRamp

R Documentation

Ramp of an area

Description

This function computes the ramp of the consumption and the balance of areas and/or districts.

Usage

netLoadRamp(
  x,
  timeStep = "hourly",
  synthesis = FALSE,
  ignoreMustRun = FALSE,
  opts = NULL
)

Arguments

`x`	Object of class `antaresData` containing data for areas and/or districts. It must contain the column `BALANCE` and either the column "netLoad" or the columns needed to compute the net load see addNetLoad.
`timeStep`	Desired time step for the result.
`synthesis`	If TRUE, average surpluses are returned. Else the function returns surpluses per Monte-Carlo scenario.
`ignoreMustRun`	Should the must run production be ignored in the computation of the net load?
`opts`	opts where clusterDesc will be read if null based on data

Value

netLoadRamp returns a data.table or a list of data.tables with the following columns:

`netLoadRamp`	Ramp of the net load of an area. If `timeStep` is not hourly, then these columns contain the average value for the given time step. Formula = netLoad - shift(netLoad, fill = 0)
`balanceRamp`	Ramp of the balance of an area. If `timeStep` is not hourly, then these columns contain the average value for the given time step. formula = BALANCE - shift(BALANCE, fill = 0)
`areaRamp`	Sum of the two previous columns. If `timeStep` is not hourly, then these columns contain the average value for the given time step. formula = netLoadRamp + balanceRamp
`minNetLoadRamp`	Minimum ramp of the net load of an area, if `timeStep` is not hourly.
`minBalanceRamp`	Minimum ramp of the balance of an area, if `timeStep` is not hourly.
`minAreaRamp`	Minimum ramp sum of the sum of balance and net load, if `timeStep` is not hourly.
`maxNetLoadRamp`	Maximum ramp of the net load of an area, if `timeStep` is not hourly.
`maxBalanceRamp`	Maximum ramp of the balance of an area, if `timeStep` is not hourly.
`maxAreaRamp`	Maximum ramp of the sum of balance and net load, if `timeStep` is not hourly.

For convenience the function invisibly returns the modified input.

Examples

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

mydata <- readAntares(select="netLoadRamp")
netLoadRamp(mydata, timeStep = "annual")

## End(Not run)

antaresProcessing documentation built on June 25, 2024, 5:07 p.m.