esqLABS / esqlabsR

Utility functions for modelling and simulation workflows within esqLABS organization
https://esqlabs.github.io/esqlabsR/
GNU General Public License v2.0
16 stars 2 forks source link

`runScenarios` documentation outdated #701

Open PavelBal opened 1 month ago

PavelBal commented 1 month ago
#' @param scenarioConfigurations List of `ScenarioConfiguration` objects to be
#' simulated.
#' @param simulationRunOptions Object of type `SimulationRunOptions` that will be passed
#' to simulation runs. If `NULL`, default options are used.
#'
#' @return A named list, where the names are scenario names, and the values are
#' lists with the entries `simulation` being the initialized `Simulation` object with applied parameters,
#' `results` being `SimulatioResults` object produced by running the simulation,
#' `outputValues` the output values of the `SimulationResults`, and `population`
#' the `Population` object if the scenario is a population simulation.
#' @details
#' If simulation of a scenario fails, a warning is produced, and the `outputValues`
#' for this scenario is `NULL`.
#'
#' @import ospsuite.parameteridentification
#' @export
runScenarios <- function(scenarios, simulationRunOptions = NULL) {

No scenarioConfigurations, must be Scenarios