antaresEditObject (version 0.5.1)

remove-cluster: Remove a cluster

Description

(thermal clusters only)

Remove a cluster, thermal or RES (renewable energy source), and all its data.

Usage

removeCluster(
  area,
  cluster_name,
  add_prefix = TRUE,
  opts = antaresRead::simOptions()
)
removeClusterRES(
  area,
  cluster_name,
  add_prefix = TRUE,
  opts = antaresRead::simOptions()
)

Value

An updated list containing various information about the simulation.

Arguments

area

The area where to create the cluster.

cluster_name

Name for the cluster, it will prefixed by area name, unless you set add_prefix = FALSE.

add_prefix

If TRUE (the default), cluster_name will be prefixed by area name.

opts

List of simulation parameters returned by the function antaresRead::setSimulationPath()

See Also

createCluster() or createClusterRES() to create new clusters, editCluster() or editClusterRES() to edit existing clusters.

Examples

if (FALSE) {
createCluster(
  area = "fr", 
  cluster_name = "fr_gas",
  group = "other", 
  `marginal-cost` = 50
)

removeCluster(area = "fr", cluster_name = "fr_gas")
}