ggstatsplot (version 0.3.1)

ggcoefstats_label_maker: Create labels with statistical details for ggcoefstats

Description

Create labels with statistical details for ggcoefstats

Usage

ggcoefstats_label_maker(
  x,
  tidy_df = NULL,
  glance_df = NULL,
  statistic = NULL,
  k = 2,
  effsize = "eta",
  partial = TRUE,
  ...
)

Arguments

x

A model object to be tidied, or a tidy data frame containing results. If a data frame is to be plotted, it must contain columns named term (names of predictors), or estimate (corresponding estimates of coefficients or other quantities of interest). Other optional columns are conf.low and conf.high (for confidence intervals); p.value. It is important that all term names should be unique. Function internally uses broom::tidy or parameters::model_parameters to get a tidy dataframe.

tidy_df

A tidy dataframe.

glance_df

A tidy model summary dataframe (default: NULL). If provided, this dataframe will be used to write caption for the final plot.

statistic

Which statistic is to be displayed (either "t" or "f"or "z") in the label. This is especially important if the x argument in ggcoefstats is a dataframe in which case the function wouldn't know what kind of model it is dealing with.

k

Number of decimal places expected for results displayed in labels (Default : k = 2).

effsize

Character describing the effect size to be displayed: "eta" (default) or "omega". This argument is relevant only for models objects of class aov, anova, and aovlist.

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 aov, anova, or aovlist.

...

Currently ignored.