editCluster {antaresEditObject} | R Documentation |
Edit an existing cluster
Description
(thermal clusters only)
Edit parameters, pre-process data and time series of an existing cluster, thermal or RES (renewable energy source).
Usage
editCluster(
area,
cluster_name,
...,
list_pollutants = NULL,
time_series = NULL,
prepro_data = NULL,
prepro_modulation = NULL,
add_prefix = TRUE,
opts = antaresRead::simOptions()
)
editClusterRES(
area,
cluster_name,
...,
time_series = NULL,
add_prefix = TRUE,
opts = antaresRead::simOptions()
)
Arguments
area |
The area where to create the cluster. |
cluster_name |
Name for the cluster, it will prefixed by area name, unless you set |
... |
Parameters to write in the Ini file. Careful!
Some parameters must be set as |
list_pollutants |
|
time_series |
the "ready-made" 8760-hour time-series available for simulation purposes. |
prepro_data |
Pre-process data, a |
prepro_modulation |
Pre-process modulation, a |
add_prefix |
If |
opts |
List of simulation parameters returned by the function
|
Value
An updated list containing various information about the simulation.
Note
Parameter list_pollutants
is only available for Antares studies >= v8.6.0.
You must provide named list
(numerical values or NULL ) :
list( "nh3"= 0.25, "nox"= 0.45, "pm2_5"= 0.25, "pm5"= 0.25, "pm10"= 0.25, "nmvoc"= 0.25, "so2"= 0.25, "op1"= 0.25, "op2"= 0.25, "op3"= 0.25, "op4"= 0.25, "op5"= NULL, "co2"= NULL)
See Also
createCluster()
or createClusterRES()
to create new clusters, removeCluster()
or removeClusterRES()
to remove clusters.
Examples
## Not run:
# Update only nominalCapacity for an existing cluster
editCluster(
area = "myarea",
cluster_name = "mycluster",
nominalcapacity = 10600.000
)
## End(Not run)