tabularInputFileColumns

fun ReportBuilder.tabularInputFileColumns(file: TabularInputFile, caption: String? = null, maxRows: Int = 500, confidenceLevel: Double = 0.95, showPlots: Boolean = true)(source)

Appends a "Columns" section for a TabularInputFile with a dedicated sub-section for each column.

For each numeric column the existing histogram DSL extension is called, which produces — at no additional cost — an overview paragraph, a bin-frequency ReportNode.DataTable, an 18-property ReportNode.StatPropertyTable (including the Missing count sourced from NaN values in the file), and optionally a ReportNode.PlotNode. Histogram.create is called with the raw DoubleArray (NaN values retained) so that numberMissing is populated correctly.

For each text column the existing stringFrequency DSL extension is called, which produces an overview paragraph, a frequency ReportNode.DataTable with columns String | Count | Cum Count | % | Cum %, and optionally a ReportNode.PlotNode bar chart. Null values in the file are mapped to "(missing)" so they appear as a tabulated category rather than being silently dropped.

At most maxRows rows are read from the file per column. Pass 0 to read all rows.

Usage:

val doc = report("Column Exploration") {
tabularInputFileColumns(tif, maxRows = 1000, showPlots = false)
}

Parameters

file

the tabular input file to detail

caption

optional section title; defaults to "Columns: <filename>"

maxRows

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

confidenceLevel

confidence level for histogram ReportNode.StatPropertyTable CI

showPlots

when true (default) a ReportNode.PlotNode is appended in each numeric column sub-section via histogram