setThematicTrimming: Set the thematic trimming of an Antares Study

In antaresEditObject: Edit an 'Antares' Simulation

Set the thematic trimming of an Antares Study

Description

Put only variables names you want to keep in study output. You can add or remove variables (use study version >=v8.8).

Usage

setThematicTrimming(
  selection_variables,
  type_select = c("add", "suppr"),
  opts = simOptions()
)

Arguments

selection_variables	character of variables to add or remove.
type_select	character select mode to add or remove (default add mode).
opts	List of simulation parameters returned by the function antaresRead::setSimulationPath()

Value

An updated list containing various information about the simulation.

Note

You can put only variables according to version of study

Examples

## Not run: 

# list of variables (version >= v8.8)
vect_select_vars <- list_thematic_variables()

##
# add all variables
##
setThematicTrimming(selection_variables = vect_select_vars$variable)

##
# remove all variables
##
setThematicTrimming(selection_variables = vect_select_vars$variable, 
                    type_select = "suppr")


## End(Not run)

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