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

toTimeSeriesReport

fun KSLDatabase.toTimeSeriesReport(expName: String, responseName: String? = null, title: String = if (responseName == null) "Time Series — $expName" else "Time Series — $responseName ($expName)", confidenceLevel: Double = 0.95, showPlots: Boolean = true): ReportNode.Document(source)

Builds a ReportNode.Document of the stored time-series data for one experiment.

When responseName is supplied, the document contains the per-replication overlay and the across-replication summary for that response. When it is null (the default), the document contains one across-replication summary per distinct time-series response recorded for the experiment.

Zero-code path:

val db = KSLDatabase("pharmacy.db")
db.toTimeSeriesReport("Experiment 1", "HourlyThroughput").showInBrowser()
db.toTimeSeriesReport("Experiment 1").writeMarkdown()   // every time-series response

Return

the assembled ReportNode.Document

Parameters

expName

the experiment to report

responseName

a single time-series response, or null for all of them

title

document title; defaults to "Time Series — " (or "Time Series — ()" for a single response)

confidenceLevel

confidence level for the per-period tables; default 0.95

showPlots

when true (default) include the plots