KSLCore/ksl.utilities.io.report.extensions/scenarioRunner

scenarioRunner

fun ReportBuilder.scenarioRunner(runner: ScenarioRunner, confidenceLevel: Double = 0.95, showTimings: Boolean = false, boxPlotResponses: List<String> = emptyList(), caption: String? = null)(source)

Appends a self-contained section reporting the full contents of runner.

Produces (inside a section titled caption or "Scenario Runner"):

Runner Overview — DataTable (Property | Value): runner name, output directory path, total scenario count, executed count, pending count
Scenario Summary sub-section — DataTable (Scenario Name | Model Name | Replications | Run Length | Warm-Up | Status | Error) with one row per scenario; the Error column shows "—" for un-executed scenarios, "No" for clean runs, and "Yes ⚠" when ksl.controls.experiments.SimulationRun.runErrorMsg is non-empty
One scenario sub-section per scenario in ScenarioRunner.scenarioList

Parameters

runner

the ScenarioRunner to report

confidenceLevel

confidence level for response statistics; defaults to 0.95

showTimings

true includes Replication Timing sub-sections in each embedded scenario run report; defaults to false

boxPlotResponses

list of response names for which a cross-scenario ksl.utilities.io.plotting.MultiBoxPlot (one box per scenario) is included in a "Response Distributions" sub-section placed after the Scenario Summary table; an empty list (default) suppresses all box plots; pass the union of all scenario response names to plot every shared response

caption

optional section title; defaults to "Scenario Runner"