warningOrNull

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

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.

The gate warns and proceeds; it never refuses. Refusing would be both paternalistic and sometimes wrong — a mixture fitted to unimodal data with a known mechanism is exactly the case where the method earns its keep, and the analyst knows about the mechanism and the tool does not.

Parameters

hasMechanism

whether the analyst has a priori reason to believe in a mixing mechanism, which the library takes as an argument rather than asking

level

the significance level for the modality test