ModalityAssessment

class ModalityAssessment(val apparentModes: Int, val unimodalityTest: ModalityTestResult, val modePersistence: ClosedRange<Double>?, val binSensitivity: Map<Int, Int>, val modeTrace: List<ModeTraceEntry>)(source)

What is known about the shape of the data before anything is fitted to it.

apparentModes

the mode count that persists over the widest span of bandwidths

unimodalityTest

Silverman's test of the hypothesis of a single mode

modePersistence

the span of bandwidths over which the apparent count holds

binSensitivity

the apparent mode count at each of several bin counts

modeTrace

the full sweep, for plotting

Constructors

constructor(apparentModes: Int, unimodalityTest: ModalityTestResult, modePersistence: ClosedRange<Double>?, binSensitivity: Map<Int, Int>, modeTrace: List<ModeTraceEntry>)

Whether the apparent mode count is an artefact of the bin count.

Whether the data shows more than one mode by the test rather than by eye.

open override fun toString(): String

fun warningOrNull(hasMechanism: Boolean, level: Double = 0.05): String?

The warning of the design review's entry gate, or null when there is nothing to warn about so that a caller cannot print an empty warning.