StatisticReporter

class StatisticReporter(listOfStats: MutableList<StatisticIfc> = ArrayList())

A class to help with making useful statistical reports. Creates summary reports as StringBuilders based on the supplied list of statistics

Author

rossetti

Parameters

listOfStats

a list containing the StatisticAccessorIfc instances

Constructors

Link copied to clipboard
constructor(listOfStats: MutableList<StatisticIfc> = ArrayList())

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

true means labeling is on report

Link copied to clipboard

Sets the report title. The title appears as the first line of any report.

Link copied to clipboard

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

Functions

Link copied to clipboard
Link copied to clipboard
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.

Link copied to clipboard

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

Link copied to clipboard
fun csvStatistics(header: Boolean = true): StringBuilder

Gets all the statistics in comma separated value format

Link copied to clipboard

Changes the number of decimal places in the average reporting.

Link copied to clipboard

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

Link copied to clipboard
fun getHalfWidthSummaryReportRow(statistic: StatisticIfc, level: Double = 0.95, df: DecimalFormat? = null): List<String>
Link copied to clipboard
fun halfWidthSummaryReport(title: String? = null, confLevel: Double = 0.95): StringBuilder

The summary statistics are presented with half-widths

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

List of StringBuilder representing LaTeX tables

Link copied to clipboard
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

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

Changes the number of spaces for printing the names

Link copied to clipboard
fun summaryReport(title: String? = null): StringBuilder

Gets the Summary Report as a StringBuilder

Link copied to clipboard

List of StringBuilder representing LaTeX tables

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun summaryReportRow(statistic: StatisticIfc, df: DecimalFormat? = null): List<String>
Link copied to clipboard
open override fun toString(): String