modulation {antaresProcessing} | R Documentation |
This function computes the modulation of cluster units or of sectors.
modulation(x, timeStep = "annual", synthesis = FALSE, by = c("cluster", "sector"), clusterDesc = NULL, opts = NULL)
x |
An |
timeStep |
Desired time step for the result. |
synthesis |
If TRUE, average surpluses are returned. Else the function returns surpluses per Monte-Carlo scenario. |
by |
Should modulations computed by cluster or by sector? Possible values are "sector" and "cluster". |
clusterDesc |
A table created with the function |
opts |
opts where clusterDesc will be read if null based on data |
A data.table of class antaresDataTable
or a list of such tables with
the following columns:
area |
Area name. If |
cluster |
Cluster name. If |
timeId |
Time id and other time columns. |
upwardModulation |
Maximal absolute modulation of a cluster unit or of the sector, if |
downwardModulation |
Maximal absolute modulation of a cluster unit or of the sector, if |
absoluteModulation |
Maximal absolute modulation of a cluster unit or of the sector, if |
avg_upwardModulation |
Average upward modulation of a cluster unit or of the sector, if |
avg_downwardModulation |
Average downward modulation of a cluster unit or of the sector, if |
avg_absoluteModulation |
Average absolute modulation of a cluster unit or of the sector, if |
max_upwardModulation |
Maximal upward modulation of a cluster unit or of the sector, if |
max_downwardModulation |
Maximal downward modulation of a cluster unit or of the sector, if |
max_absoluteModulation |
Maximal absolute modulation of a cluster unit or of the sector, if |
Notice that if by="cluster"
, the function computes the modulation per
unit, ie. The modulation of a cluster divided by the number of units of the
cluster. On the opposite, if by="sector"
, the function returns the
modulation of the global production of the sector. Moreover, if parameter
x
contains area and district data, the function returns a list with
components areas
and districts
.
## Not run: # data required by the function showAliases("modulation") mydata <- readAntares(select="modulation") # Modulation of cluster units modulation(mydata) # Aggregate Monte-Carlo scenarios modulation(mydata, synthesis = TRUE) # Modulation of sectors modulation(mydata, by = "sector") # Modulation of sectors per district modulation(mydata, by = "sector") ## End(Not run)