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

tabularInputFileResults

fun ReportBuilder.tabularInputFileResults(file: TabularInputFile, maxRows: Int = 500, confidenceLevel: Double = 0.95, detail: Boolean = false, showPlots: Boolean = true)(source)

Appends the canonical full report for a TabularInputFile: a summary section followed by a per-column detail section.

This is the DB-equivalent of dbSimulationResults: a single call that produces the complete standard report structure. Both component sections can also be called independently when finer control over layout is needed.

Produces in order:

tabularInputFileSummary — schema + compact stats + text summary
tabularInputFileColumns — per-column drill-down with histograms / frequencies

Usage:

val doc = report("Sensor Readings") {
    tabularInputFileResults(tif, maxRows = 2000, detail = true)
}
doc.showInBrowser()

Parameters

file

the tabular input file to report

maxRows

maximum rows read per column; 0 = all rows; defaults to 500

confidenceLevel

confidence level for all statistical tables; must be in (0, 1)

detail

true appends a diagnostic table to the tabularInputFileSummary stat table (skewness, kurtosis, Lag-1 correlation, Von Neumann)

showPlots

when true (default) histogram plots are included in the column detail section