KSLCore/ksl.utilities.statistic/BoxPlotSummary

BoxPlotSummary

class BoxPlotSummary(data: DoubleArray, name: String? = null) : IdentityIfc, BoxPlotDataIfc

Prepares the statistical quantities typically found on a box plot. This implementation uses a full sort of the data. The original data is not changed. Users may want to look for more efficient methods for use with very large data sets.

Lower inner fence: Q1 – (1.5 * IQR)
Upper inner fence: Q3 + (1.5 * IQR)
Lower outer fence: Q1 – (3 * IQR)
upper outer fence: Q3 + (3 * IQR)

Parameters

data

the data to be summarized, must not be null and must not contain any Double.NaN values

Constructors

BoxPlotSummary

constructor(data: DoubleArray, name: String? = null)

Properties

average

val average: Double

count

open override val count: Double

firstQuartile

open override var firstQuartile: Double

open override val id: Int

interQuartileRange

val interQuartileRange: Double

label

open override var label: String?

lowerInnerFence

val lowerInnerFence: Double

lowerOuterFence

val lowerOuterFence: Double

lowerWhisker

val lowerWhisker: Double

The smallest data point that is greater than or equal to the lowerInnerFence

max

open override var max: Double

median

open override var median: Double

min

open override var min: Double

name

open override val name: String

range

val range: Double

standardDeviation

val standardDeviation: Double

thirdQuartile

open override var thirdQuartile: Double

upperInnerFence

val upperInnerFence: Double

upperOuterFence

val upperOuterFence: Double

upperWhisker

val upperWhisker: Double

The largest data point that is less than or equal to the upperInnerFence

variance

val variance: Double

Functions

asMap

fun asMap(): Map<String, Double>

The summary as a map of values

boxPlot

fun boxPlot(): BoxPlot

confidenceInterval

fun confidenceInterval(level: Double): Interval

A confidence interval for the mean based on the confidence level

lowerOuterPoints

fun lowerOuterPoints(): DoubleArray

orderStatistics

fun orderStatistics(): DoubleArray

The order statistics

percentile

fun percentile(p: Double): Double

As per Apache Math commons

pointsBtwLowerInnerAndOuterFences

fun pointsBtwLowerInnerAndOuterFences(): DoubleArray

pointsBtwUpperInnerAndOuterFences

fun pointsBtwUpperInnerAndOuterFences(): DoubleArray

quantile

fun quantile(p: Double): Double

Uses definition 7, as per R definitions

statistics

fun statistics(): Statistic

The statistical summary of the data

toDataFrame

fun BoxPlotSummary.toDataFrame(): DataFrame<BoxPlotDataIfc>

Converts the box plot summary data to a data frame with two columns. The first column holds the name of the statstics and the second column holds the values.

toString

open override fun toString(): String

upperOuterPoints

fun upperOuterPoints(): DoubleArray