antaresEditObject (version 0.6.4)

updateOutputSettings: Update output parameters of an Antares study

Description

Update output parameters of an Antares study

Usage

updateOutputSettings(
  synthesis = NULL,
  storenewset = NULL,
  archives = NULL,
  result.format = NULL,
  opts = antaresRead::simOptions()
)

Value

An updated list containing various information about the simulation.

Arguments

synthesis

Logical. If TRUE, synthetic results will be stored in a directory Study_name/OUTPUT/simu_tag/Economy/mc-all. If FALSE, No general synthesis will be printed out.

storenewset

Logical. See Antares General Reference Guide.

archives

Character vector. Series to archive.

result.format

Character. Output format (txt-files or zip).

opts

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

Examples

if (FALSE) {

updateOutputSettings(
  synthesis = TRUE,
  storenewset = FALSE,
  archives = c("load", "wind"),
  result.format = "zip"
)

}