antaresEditObject (version 0.9.0)

removeBindingConstraint: Remove a Binding Constraint

Description

Remove a binding constraint in an Antares study.

Usage

removeBindingConstraint(
  name = NULL,
  group = NULL,
  opts = antaresRead::simOptions()
)

Value

An updated list containing various information about the simulation.

Arguments

name

Name(s) of the binding constraint(s) to remove.

group

character Name(s) of group to delete

opts

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

See Also

Other binding constraints functions: createBindingConstraintBulk(), createBindingConstraint(), editBindingConstraint()

Examples

if (FALSE) {
# < v8.7.0 :
removeBindingConstraint(name = "mybindingconstraint")

# >= v8.7.0 (delete by names group) :
# read
bc <- readBindingConstraints()

# select all groups
group_to_delete <- sapply(bc, function(x){
  x$properties$group
})

# delete all groups
removeBindingConstraint(group = group_to_delete)
}