updateOutputSettings: Update output parameters of an Antares study

In rte-antares-rpackage/antaresEditObject: Edit an 'Antares' Simulation

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

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. See Antares General Reference Guide (see link below).
storenewset	Logical. See Antares General Reference Guide (see link below).
archives	Character vector. Series to archive. See Antares General Reference Guide (see link below).
result.format	Character. Output format (txt-files or zip). See Antares General Reference Guide (see link below).
opts	List of simulation parameters returned by the function antaresRead::setSimulationPath()

Value

An updated list containing various information about the simulation.

See Also

Antares General Reference Guide

Examples

## Not run: 

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


## End(Not run)

rte-antares-rpackage/antaresEditObject documentation built on Feb. 19, 2025, 6:47 p.m.