Build an effect-size result — effect_size_result • rmorie

Returns a named-list with class c("morie_effect_size", "list").

Usage

effect_size_result(
  measure,
  estimate,
  ci_lower = NA_real_,
  ci_upper = NA_real_,
  se = NA_real_,
  n = NA_integer_,
  extra = list()
)

Arguments

measure: Name of the effect-size statistic.
estimate: Point estimate (numeric).
ci_lower: Lower confidence bound (or NA).
ci_upper: Upper confidence bound (or NA).
se: Standard error (or NA).
n: Sample size (or NA).
extra: Named list of additional outputs.

Value

A morie_effect_size named-list.

Examples

r <- effect_size_result("demo", 0.5, ci_lower = 0.1, ci_upper = 0.9,
                        se = 0.2, n = 50L, extra = list(foo = 1))
r$estimate
#> [1] 0.5
r$extra$foo
#> [1] 1