antaresEditObject (version 0.6.4)

variant: 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())

Value

An updated list containing various information about the simulation.

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.

Examples

if (FALSE) {
# See vignette for complete documentation
vignette("api-variant-management")
}