create-study: Create an empty Antares study

In antaresEditObject: Edit an 'Antares' Simulation

Create an empty Antares study

Description

Create study on disk or with AntaREST server through the API.

Usage

createStudy(path, study_name = "my_study", antares_version = "8.2.0")

createStudyAPI(
  host,
  token = NULL,
  study_name = "my_study",
  antares_version = "8.2.0",
  ...
)

Arguments

path	Path where to create study, it should be an empty directory, if it doesn't exist, it'll be created.
study_name	Name of the study.
antares_version	Antares number version.
host	Host of AntaREST server API.
token	API personnal access token.
...	Other query parameters passed to POST request.

Value

Result of antaresRead::setSimulationPath() or setSimulationPathAPI() accordingly.

Examples

## Not run: 

createStudy("path/to/simulation")


## End(Not run)

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