setAPImode: Set API mode

View source: R/API.R

setAPImodeR Documentation

Set API mode

Description

Two modes are available when using the API:

  • async: record all API calls, but nothing is sent to the server

  • sync: send query to the API each time a function is used

Usage

setAPImode(mode = c("sync", "async"), opts = antaresRead::simOptions())

Arguments

mode

The mode you want to use.

opts

List of simulation parameters returned by the function antaresRead::setSimulationPath()

Value

An updated list containing various information about the simulation.

Examples

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

# Usage :
setAPImode("sync")


## End(Not run)

antaresEditObject documentation built on Oct. 4, 2023, 1:06 a.m.