createDistrict {antaresEditObject} | R Documentation |
Create a district
Description
Allows selecting a set of areas so as to bundle them together in a "district".
Usage
createDistrict(
name,
caption = NULL,
comments = NULL,
apply_filter = c("none", "add-all", "remove-all"),
add_area = NULL,
remove_area = NULL,
output = FALSE,
overwrite = FALSE,
opts = antaresRead::simOptions()
)
Arguments
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
|
Value
An updated list containing various information about the simulation.
Examples
## Not run:
createDistrict(
name = "mydistrict",
apply_filter = "add-all",
remove_area = c("fr", "be")
)
## End(Not run)
[Package antaresEditObject version 0.6.1 Index]