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

simulationSummary

fun ReportBuilder.simulationSummary(reporter: SimulationReporter, model: Model? = null, confidenceLevel: Double = 0.95)(source)

Appends a section containing simulation metadata (model name, experiment name, replications, run length, warm-up length) and the across-replication statistics half-width summary table.

Usage:

val doc = report("Quick Summary") {
    simulationSummary(model.simulationReporter, model)
}

Parameters

reporter

the SimulationReporter whose across-replication statistics will be tabulated

model

the Model providing experiment metadata; when null metadata is omitted and only the statistics table is produced

confidenceLevel

confidence level for half-width and CI columns; must be in (0, 1)