kstats-hypothesis/org.oremif.kstats.hypothesis/RiskEstimate

RiskEstimate

data class RiskEstimate(val estimate: Double, val ci: ConfidenceInterval, val confidenceLevel: Double)(source)

The result of a risk or association measure computed from a 2×2 contingency table.

Contains the point estimate (e.g. odds ratio or relative risk) together with a confidence interval computed at the requested confidence level.

Example:

val table = arrayOf(intArrayOf(10, 20), intArrayOf(30, 40))
val result = oddsRatio(table)
result.estimate         // 0.6667 (point estimate)
result.ci               // (0.272, 1.632) Woolf 95% CI
result.confidenceLevel  // 0.95

Constructors

RiskEstimate

constructor(estimate: Double, ci: ConfidenceInterval, confidenceLevel: Double)

Properties

val ci: ConfidenceInterval

the confidence interval. Both bounds are Double.NaN when the interval cannot be computed (e.g. when a cell is zero or the confidence level is NaN).

confidenceLevel

val confidenceLevel: Double

the confidence level at which ci was computed.

estimate

val estimate: Double

the point estimate of the association measure. May be 0.0, Double.POSITIVE_INFINITY, or Double.NaN when the contingency table contains zero cells.