Helper function for ggstatsplot::ggdotplotstats to apply this function across multiple levels of a given factor and combining the resulting plots using ggstatsplot::combine_plots.

grouped_ggdotplotstats(
  data,
  x,
  y,
  grouping.var,
  title.prefix = NULL,
  output = "plot",
  ...,
  plotgrid.args = list(),
  title.text = NULL,
  title.args = list(size = 16, fontface = "bold"),
  caption.text = NULL,
  caption.args = list(size = 10),
  sub.text = NULL,
  sub.args = list(size = 12)
)

Arguments

data

A dataframe (or a tibble) from which variables specified are to be taken. A matrix or tables will not be accepted.

x

A numeric variable from the dataframe data.

y

Label or grouping variable.

grouping.var

A single grouping variable (can be entered either as a bare name x or as a string "x").

title.prefix

Character string specifying the prefix text for the fixed plot title (name of each factor level) (Default: NULL). If NULL, the variable name entered for grouping.var will be used.

output

If "expression", will return expression with statistical details, while "dataframe" will return a dataframe containing the results.

...

Arguments passed on to ggdotplotstats

point.args

A list of additional aesthetic arguments passed to geom_point.

test.value

A number specifying the value of the null hypothesis (Default: 0).

test.k

Integer denoting the number of decimal places expected for test.value label. (Default: 0 ).

test.value.line

Logical that decides whether a line corresponding to the test.value should be superimposed on the plot.

test.value.line.args

A list of additional aesthetic arguments to be passed to the geom_line used to display the lines corresponding to the centrality parameter and test value.

test.value.label.args

A list of additional aesthetic arguments to be passed to the geom_label used to display the label corresponding to the centrality parameter and test value.

centrality.parameter

Decides which measure of central tendency ("mean" or "median") is to be displayed as a vertical line. To not show any parameter, set this to "none".

centrality.k

Integer denoting the number of decimal places expected for centrality parameter label. (Default: 2).

centrality.line.args

A list of additional aesthetic arguments to be passed to the geom_line used to display the lines corresponding to the centrality parameter and test value.

centrality.label.args

A list of additional aesthetic arguments to be passed to the geom_label used to display the label corresponding to the centrality parameter and test value.

xlab

Labels for x and y axis variables. If NULL (default), variable names for x and y will be used.

subtitle

The text for the plot subtitle. Will work only if results.subtitle = FALSE.

caption

The text for the plot caption.

type

Type of statistic expected ("parametric" or "nonparametric" or "robust" or "bayes").Corresponding abbreviations are also accepted: "p" (for parametric), "np" (nonparametric), "r" (robust), or "bf"resp.

bf.prior

A number between 0.5 and 2 (default 0.707), the prior width to use in calculating Bayes factors.

bf.message

Logical that decides whether to display Bayes Factor in favor of the null hypothesis. This argument is relevant only for parametric test (Default: TRUE).

effsize.type

Type of effect size needed for parametric tests. The argument can be "d" (for Cohen's d) or "g" (for Hedge's g).

conf.level

Scalar between 0 and 1. If unspecified, the defaults return 95% lower and upper confidence intervals (0.95).

nboot

Number of bootstrap samples for computing confidence interval for the effect size (Default: 100).

k

Number of digits after decimal point (should be an integer) (Default: k = 2L).

results.subtitle

Decides whether the results of statistical tests are to be displayed as a subtitle (Default: TRUE). If set to FALSE, only the plot will be returned.

ggplot.component

A ggplot component to be added to the plot prepared by ggstatsplot. This argument is primarily helpful for grouped_ variant of the current function. Default is NULL. The argument should be entered as a function.

ggtheme

A function, ggplot2 theme name. Default value is ggplot2::theme_bw(). Any of the ggplot2 themes, or themes from extension packages are allowed (e.g., ggthemes::theme_fivethirtyeight(), hrbrthemes::theme_ipsum_ps(), etc.).

ggstatsplot.layer

Logical that decides whether theme_ggstatsplot theme elements are to be displayed along with the selected ggtheme (Default: TRUE). theme_ggstatsplot is an opinionated theme layer that override some aspects of the selected ggtheme.

ylab

Labels for x- and y- axis variables, respectively (Defaults: "regression coefficient" and "term").

plotgrid.args

A list of additional arguments to cowplot::plot_grid.

title.text

String or plotmath expression to be drawn as title for the combined plot.

title.args

A list of additional arguments provided to title, caption and sub, resp.

caption.text

String or plotmath expression to be drawn as the caption for the combined plot.

caption.args

A list of additional arguments provided to title, caption and sub, resp.

sub.text

The label with which the combined plot should be annotated. Can be a plotmath expression.

sub.args

A list of additional arguments provided to title, caption and sub, resp.

References

https://indrajeetpatil.github.io/ggstatsplot/articles/web_only/ggdotplotstats.html

See also

Author

Indrajeet Patil

Examples

# \donttest{ # for reproducibility set.seed(123) # removing factor level with very few no. of observations df <- dplyr::filter(.data = ggplot2::mpg, cyl %in% c("4", "6", "8")) # plot ggstatsplot::grouped_ggdotplotstats( data = df, x = "cty", y = "manufacturer", grouping.var = "cyl", test.value = 15.5, title.prefix = "cylinder count", ggplot.component = ggplot2::scale_x_continuous( sec.axis = ggplot2::dup_axis(), limits = c(12, 24), breaks = seq(12, 24, 2) ), messages = FALSE )
#> Scale for 'x' is already present. Adding another scale for 'x', which will replace the existing scale.
#> Scale for 'x' is already present. Adding another scale for 'x', which will replace the existing scale.
#> Scale for 'x' is already present. Adding another scale for 'x', which will replace the existing scale.
# }