(thermal clusters only)
Remove a cluster, thermal RES (renewable energy source) or short-term storage, and all its data.
removeCluster(
area,
cluster_name,
add_prefix = TRUE,
opts = antaresRead::simOptions()
)
removeClusterRES(
area,
cluster_name,
add_prefix = TRUE,
opts = antaresRead::simOptions()
)
removeClusterST(
area,
cluster_name,
add_prefix = TRUE,
opts = antaresRead::simOptions()
)
The area where to create the cluster.
Name for the cluster, it will prefixed by area name, unless you set add_prefix = FALSE
.
If TRUE
(the default), cluster_name
will be prefixed by area name.
List of simulation parameters returned by the function
antaresRead::setSimulationPath()
An updated list containing various information about the simulation.
createCluster()
, createClusterRES()
or createClusterST()
to create new clusters,
editCluster()
or editClusterRES()
or editClusterST()
to edit existing clusters.
if (FALSE) {
createCluster(
area = "fr",
cluster_name = "fr_gas",
group = "other",
`marginal-cost` = 50
)
removeCluster(area = "fr", cluster_name = "fr_gas")
}