antaresEditObject (version 0.1.6)

removeCluster: Remove a cluster

Description

Remove a cluster

Usage

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

Arguments

area

Area from which to remove a cluster.

cluster_name

Cluster to remove.

add_prefix

If TRUE, cluster_name will be prefixed by area's name.

opts

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

Value

An updated list containing various information about the simulation.

Examples

# NOT RUN {
createCluster(area = "fr", cluster_name = "fr_gas",
              group = "other", `marginal-cost` = 50)

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

# }
# NOT RUN {

# }