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

toHistogramReport

fun KSLDatabase.toHistogramReport(expName: String, responseName: String? = null, title: String = if (responseName == null) "Histograms — $expName" else "Histogram — $responseName ($expName)", showPlot: Boolean = true): ReportNode.Document(source)

Builds a ReportNode.Document for the stored histogram data of one experiment.

When responseName is supplied, the document covers that one histogram response; when it is null (the default), the document covers every histogram response recorded for the experiment (via dbSimulationHistograms).

Zero-code path:

val db = KSLDatabase("pharmacy.db")
db.toHistogramReport("Experiment 1", "SystemTime:Histogram").showInBrowser()
db.toHistogramReport("Experiment 1").writeMarkdown()   // every histogram

Return

the assembled ReportNode.Document

Parameters

expName

the experiment to report

responseName

a single histogram response, or null for all of them

title

document title; defaults to "Histograms — " (or "Histogram — ()" for one)

showPlot

when true (default) include the histogram plots