ggstatsplot (version 0.6.5)

lm_effsize_standardizer: Confidence intervals for (partial) eta-squared and omega-squared for linear models.

Description

This function will convert a linear model object to a dataframe containing statistical details for all effects along with effect size measure and its confidence interval. For more details, see effectsize::eta_squared and effectsize::omega_squared.

Usage

lm_effsize_standardizer(
  object,
  effsize = "eta",
  partial = TRUE,
  conf.level = 0.95,
  ...
)

Arguments

object

The linear model object (can be of class lm, aov, anova, or aovlist).

effsize

Character describing the effect size to be displayed: "eta" (default) or "omega".

partial

Logical that decides if partial eta-squared or omega-squared are returned (Default: TRUE). If FALSE, eta-squared or omega-squared will be returned. Valid only for objects of class lm, aov, anova, or aovlist.

conf.level

Numeric specifying Level of confidence for the confidence interval (Default: 0.95).

...

Ignored.

Value

A dataframe with results from stats::lm() with partial eta-squared, omega-squared, and bootstrapped confidence interval for the same.

Examples

# NOT RUN {
# for reproducibility
set.seed(123)

# model
mod <-
  stats::aov(
    formula = mpg ~ wt + qsec + Error(disp / am),
    data = mtcars
  )

# dataframe with effect size and confidence intervals
ggstatsplot:::lm_effsize_standardizer(mod)
# }