mockSimulationAPI: Mock API usage

In antaresEditObject: Edit an 'Antares' Simulation

Mock API usage

Description

Use this to generate command without an active API connection, it allow to use function to edit a study to later on get API commands.

Usage

mockSimulationAPI(force = FALSE, antares_version = "8.2.0")

Arguments

force	Logical, force mocking simulation even if antaresRead::setSimulationPathAPI has already been called.
antares_version	Antares version number.

Value

An updated list containing various information about the simulation.

Examples

## Not run: 
# Mock simulation API
mockSimulationAPI()
# Create an area
createArea("new area")
# Get commands
getVariantCommands()

## End(Not run)

antaresEditObject documentation built on Dec. 6, 2022, 5:10 p.m.