removeBindingConstraint: Remove a Binding Constraint

In antaresEditObject: Edit an 'Antares' Simulation

Remove a Binding Constraint

Description

Remove a binding constraint in an Antares study.

Usage

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

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()

Value

An updated list containing various information about the simulation.

Note

Starting with version v8.7.0, you can delete binding constraints by name or by group.

See Also

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

Examples

## Not run: 
# < 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)

## End(Not run)

antaresEditObject documentation built on April 4, 2025, 4:25 a.m.