variant: Create a study's variant

In antaresEditObject: Edit an 'Antares' Simulation

Create a study's variant

Description

API: create a new variant for a given study or use a pre-existing one.

Usage

createVariant(name, opts = antaresRead::simOptions())

useVariant(name, variant_id = NULL, opts = antaresRead::simOptions())

Arguments

name	Name for the variant to create or the name of an existent variant.
opts	List of simulation parameters returned by the function antaresRead::setSimulationPath()
variant_id	ID of the variant to use, if specified name is ignored.

Value

An updated list containing various information about the simulation.

Examples

## Not run: 
# See vignette for complete documentation
vignette("api-variant-management")

## End(Not run)

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