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

dataStatisticalSummary

fun ReportBuilder.dataStatisticalSummary(data: PDFData, caption: String? = null, confidenceLevel: Double = 0.95, showOutlierValues: Boolean = false)(source)

Appends a self-contained section summarising the characteristics of the raw data held by data, with no plots.

Produces (inside a section titled caption or "Data Statistical Summary"):

Overview paragraph — n, mean, std dev, zero count, negative count
StatPropertyTable — full 18-row property sheet on the sample statistics
Box Plot Summary sub-section — five-number summary + fence values as a DataTable; outlier summary table (Category | Fence Range | Count | Obs. Min | Obs. Max); when showOutlierValues is true, per-category detail tables listing individual outlier values are appended after the summary table
Histogram sub-section — bin frequency table + statistics on binned data (no plot; call dataVisualization for the histogram plot)
Shift Parameter Analysis sub-section — estimated left-shift, zero/negative flags, tolerance, and bootstrap 95 % CI for the minimum

Parameters

data

the PDFData whose sample will be summarised

caption

optional section title

confidenceLevel

confidence level for the StatPropertyTable CI; must be in (0, 1)

showOutlierValues

when false (default) each outlier category is summarised in a single row (count, observed min/max). When true, a per-category DataTable listing every individual outlier value is appended for each non-empty category.