A read-only snapshot of the statistics currently held by this reporter. Useful for passing to the reporting framework's ksl.utilities.io.report.extensions extension functions without exposing the mutable internal list.

timeDateFlag

var timeDateFlag: Boolean

Indicate whether to have time/date on the report true means yes

Functions

addStatistic

fun addStatistic(name: String): Statistic

fun addStatistic(statistic: StatisticIfc)

addStatistics

fun <T : StatisticIfc> addStatistics(stats: List<T>)

Adds a list of statistics to the reporter

asDataFrame

@JvmOverloads

fun asDataFrame(level: Double = 0.95): DataFrame<StatisticData>

Converts the statistics in the reporter to a data frame containing the statistical data with confidence intervals specified the supplied level. The default level is 0.95.

confidenceIntervals

@JvmOverloads

fun confidenceIntervals(level: Double = 0.95): Map<String, Interval>

The confidence intervals for the statistics on the report with the key being the name of the statistic

csvStatistics

@JvmOverloads

fun csvStatistics(header: Boolean = true): StringBuilder

Gets all the statistics in comma separated value format

decimalPlaces

fun decimalPlaces(n: Int)

Changes the number of decimal places in the average reporting.

findSizeOfLongestName

fun findSizeOfLongestName(): Int

Finds the number of characters of the statistic with the longest name

getHalfWidthSummaryReportHeader

fun getHalfWidthSummaryReportHeader(): List<String>

Gets the half-width summary report as headers as a list of strings

getHalfWidthSummaryReportRow

@JvmOverloads

fun getHalfWidthSummaryReportRow(statistic: StatisticIfc, level: Double = 0.95, df: DecimalFormat? = null): List<String>

Gets the half-width summary report rows as a list of strings

halfWidthSummaryReport

@JvmOverloads

fun halfWidthSummaryReport(title: String? = null, confLevel: Double = 0.95): StringBuilder

The summary statistics are presented with half-widths

halfWidthSummaryReportAsLaTeXTables

@JvmOverloads

fun halfWidthSummaryReportAsLaTeXTables(maxRows: Int = 60, confLevel: Double = 0.95): List<StringBuilder>

List of StringBuilder representing LaTeX tables

halfWidthSummaryReportAsLaTeXTabular

@JvmOverloads

fun halfWidthSummaryReportAsLaTeXTabular(maxRows: Int = 60, confLevel: Double = 0.95): List<StringBuilder>

Gets statistics as LaTeX tabular. Each StringBuilder in the list represents a tabular with a maximum number of rows

halfWidthSummaryReportAsMarkDown

@JvmOverloads

fun halfWidthSummaryReportAsMarkDown(title: String? = null, level: Double = 0.95, df: DecimalFormat? = null): StringBuilder

Gets the half-width summary report as a MarkDown string

printHalfWidthSummaryReport

@JvmOverloads

fun printHalfWidthSummaryReport(title: String? = null, level: Double = 0.95)

The summary statistics are presented with half-widths

printSummaryReport

@JvmOverloads

fun printSummaryReport(title: String? = null)

Prints the summary report to standard out

setNameFieldSize

fun setNameFieldSize(n: Int)

Changes the number of spaces for printing the names

summaryReport

@JvmOverloads

fun summaryReport(title: String? = null): StringBuilder

Gets the Summary Report as a StringBuilder

summaryReportAsLaTeXTables

@JvmOverloads

fun summaryReportAsLaTeXTables(maxRows: Int = 60): List<StringBuilder>

List of StringBuilder representing LaTeX tables

summaryReportAsLaTeXTabular

@JvmOverloads

fun summaryReportAsLaTeXTabular(maxRows: Int = 60): List<StringBuilder>

Gets statistics as LaTeX tabular. Each StringBuilder in the list represents a tabular with a maximum number of rows

summaryReportAsMarkDown

@JvmOverloads

fun summaryReportAsMarkDown(title: String? = null, df: DecimalFormat?): StringBuilder

Gets the summary report as a MarkDown string

summaryReportHeader

fun summaryReportHeader(): List<String>

Gets the summary report as headers as a list of strings

summaryReportRow

@JvmOverloads

fun summaryReportRow(statistic: StatisticIfc, df: DecimalFormat? = null): List<String>

Gets the summary report rows as a list of strings

toReport

fun StatisticReporter.toReport(title: String = reportTitle ?: "Statistical Report", confidenceLevel: Double = 0.95, block: ReportBuilder.() -> Unit = { statistics(this@toReport.statistics, confidenceLevel = confidenceLevel) }): ReportNode.Document

Builds a ReportNode.Document whose default content is a compact half-width summary ksl.utilities.io.report.ast.ReportNode.StatTable for all statistics held by this reporter.

toString

open override fun toString(): String