Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

runScenarios documentation outdated #701

Open
PavelBal opened this issue Aug 14, 2024 · 0 comments
Open

runScenarios documentation outdated #701

PavelBal opened this issue Aug 14, 2024 · 0 comments

Comments

@PavelBal
Copy link
Member

#' @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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant