netLoadRamp {antaresProcessing} | R Documentation |
This function computes the ramp of the consumption and the balance of areas and/or districts.
netLoadRamp( x, timeStep = "hourly", synthesis = FALSE, ignoreMustRun = FALSE, opts = NULL )
x |
Object of class |
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 |
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 |
balanceRamp |
Ramp of the balance of an area. If formula = BALANCE - shift(BALANCE, fill = 0) |
areaRamp |
Sum of the two previous columns. If formula = netLoadRamp + balanceRamp |
minNetLoadRamp |
Minimum ramp of the net load of an area, if |
minBalanceRamp |
Minimum ramp of the balance of an area, if |
minAreaRamp |
Minimum ramp sum of the sum of balance and net load, if |
maxNetLoadRamp |
Maximum ramp of the net load of an area, if |
maxBalanceRamp |
Maximum ramp of the balance of an area, if |
maxAreaRamp |
Maximum ramp of the sum of balance and net load, if |
For convenience the function invisibly returns the modified input.
## Not run: # data required by the function showAliases("netLoadRamp") mydata <- readAntares(select="netLoadRamp") netLoadRamp(mydata, timeStep = "annual") ## End(Not run)