removeDistrict: Remove a district

View source: R/district.R

removeDistrictR Documentation

Remove a district

Description

Remove a district

Usage

removeDistrict(name, opts = simOptions())

Arguments

name

District's name.

opts

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

Value

An updated list containing various information about the simulation.

See Also

createDistrict()

Examples

## Not run: 
removeDistrict(
  name = "mydistrict",
  opts = simOptions()
)

## End(Not run)

antaresEditObject documentation built on Nov. 5, 2025, 7:30 p.m.