KSLCore/ksl.utilities.moda/MetricRecord

MetricRecord

data class MetricRecord(val name: String, val direction: String, val weight: Double, val declaredLowerLimit: Double, val declaredUpperLimit: Double, val effectiveLowerLimit: Double, val effectiveUpperLimit: Double, val domainWasRescaled: Boolean, val allowLowerLimitAdjustment: Boolean, val allowUpperLimitAdjustment: Boolean, val realizedLowestScore: Double? = null, val realizedHighestScore: Double? = null, val hadTiedScores: Boolean, val valueFunctionId: String, val unitsOfMeasure: String?, val description: String?)(source)

What was known about one metric at the moment a study was evaluated.

Both domains are carried because they answer different questions. The declared domain is what the study said the metric could range over. The effective domain is what the values were actually computed against, which differs whenever the domain was fitted to the realized scores. Reporting only the declared one leaves the values unexplained; reporting only the effective one hides that any fitting happened.

Constructors

MetricRecord

constructor(name: String, direction: String, weight: Double, declaredLowerLimit: Double, declaredUpperLimit: Double, effectiveLowerLimit: Double, effectiveUpperLimit: Double, domainWasRescaled: Boolean, allowLowerLimitAdjustment: Boolean, allowUpperLimitAdjustment: Boolean, realizedLowestScore: Double? = null, realizedHighestScore: Double? = null, hadTiedScores: Boolean, valueFunctionId: String, unitsOfMeasure: String?, description: String?)