createDistrict {antaresEditObject} | R Documentation |
Allows selecting a set of areas so as to bundle them together in a "district".
createDistrict(name, caption = NULL, comments = NULL, apply_filter = "none", add_area = NULL, remove_area = NULL, output = FALSE, overwrite = FALSE, opts = antaresRead::simOptions())
name |
District's name. |
caption |
Caption for the district. |
comments |
Comments for the district. |
apply_filter |
Possible values are |
add_area |
Character vector of area(s) to add to the district. |
remove_area |
Character vector of area(s) to remove from the district. |
output |
Logical, compute the results for the district or not? |
overwrite |
Logical, should the district be overwritten if already exist? |
opts |
List of simulation parameters returned by the function
|
An updated list containing various information about the simulation.
## Not run: createDistrict(name = "mydistrict", apply_filter = "add-all", remove_area = c("fr", "be")) ## End(Not run)