updateAdequacySettings: Update adequacy parameters of an Antares study

View source: R/updateAdequacySettings.R

updateAdequacySettingsR Documentation

Update adequacy parameters of an Antares study

Description

Antares API OK

Update adequacy parameters of an Antares study

Usage

updateAdequacySettings(
  include_adq_patch = NULL,
  set_to_null_ntc_from_physical_out_to_physical_in_for_first_step = NULL,
  set_to_null_ntc_between_physical_out_for_first_step = NULL,
  opts = antaresRead::simOptions()
)

Arguments

include_adq_patch

Logical. If TRUE, will run Adequacy Patch

set_to_null_ntc_from_physical_out_to_physical_in_for_first_step

Logical. default to TRUE

set_to_null_ntc_between_physical_out_for_first_step

Logical. default to TRUE

opts

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

Value

An updated list containing various information about the simulation.

Examples

## Not run: 

updateAdequacySettings(
  include_adq_patch = TRUE,
  set_to_null_ntc_from_physical_out_to_physical_in_for_first_step = TRUE,
  set_to_null_ntc_between_physical_out_for_first_step = TRUE
)


## End(Not run)


antaresEditObject documentation built on Dec. 6, 2022, 5:10 p.m.