write-ini: Write configuration options in file or API

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

Write configuration options in file or API

Description

Write configuration options in file or API

Usage

writeIni(
  listData,
  pathIni,
  opts = antaresRead::simOptions(),
  ...,
  default_ext = ".ini"
)

writeIniFile(listData, pathIni, overwrite = FALSE)

writeIniAPI(listData, pathIni, opts)

Arguments

listData	list, modified list obtained by antaresRead:::readIniFile.
pathIni	Character, Path to ini file.
opts	List of simulation parameters returned by the function antaresRead::setSimulationPath()
...	Additional arguments.
default_ext	Default extension used for config files.
overwrite	logical, should file be overwritten if already exist?

Examples

## Not run: 
pathIni <- "D:/exemple_test/settings/generaldata.ini"
generalSetting <- readIniFile(pathIni)
generalSetting$output$synthesis <- FALSE
writeIni(generalSetting, pathIni)

## End(Not run)

rte-antares-rpackage/antaresEditObject documentation built on May 3, 2024, 10:33 a.m.