ggstatsplot: grouped_ggdotplotstats – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

grouped_ggdotplotstats

Grouped histograms for distribution of a labeled numeric variable

Description

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.

Usage

grouped_ggdotplotstats(
  data,
  x,
  y,
  grouping.var,
  output = "plot",
  plotgrid.args = list(),
  annotation.args = list(),
  ...
)

Arguments

`data`	A dataframe (or a tibble) from which variables specified are to be taken. Other data types (e.g., matrix,table, array, etc.) 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"`).
`output`	Character that describes what is to be returned: can be `"plot"` (default) or `"subtitle"` or `"caption"`. Setting this to `"subtitle"` will return the expression containing statistical results. If you have set `results.subtitle = FALSE`, then this will return a `NULL`. Setting this to `"caption"` will return the expression containing details about Bayes Factor analysis, but valid only when `type = "parametric"` and `bf.message = TRUE`, otherwise this will return a `NULL`.
`plotgrid.args`	A `list` of additional arguments passed to `patchwork::wrap_plots`, except for `guides` argument which is already separately specified here.
`annotation.args`	A `list` of additional arguments passed to `patchwork::plot_annotation`.
`...`	Arguments passed on to `ggdotplotstats` `point.args` A list of additional aesthetic arguments passed to `geom_point`. `type` A character specifying the type of statistical approach. Four possible options: `"parametric"` `"nonparametric"` `"robust"` `"bayes"` Corresponding abbreviations are also accepted: `"p"` (for parametric), `"np"` (for nonparametric), `"r"` (for robust), or `"bf"` (for Bayesian). `tr` Trim level for the mean when carrying out `robust` tests. In case of an error, try reducing the value of `tr`, which is by default set to `0.2`. Lowering the value might help. `k` Number of digits after decimal point (should be an integer) (Default: `k = 2L`). `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. `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. `test.value` A number indicating the true value of the mean (Default: `0`). `bf.prior` A number between `0.5` and `2` (default `0.707`), the prior width to use in calculating Bayes factors and posterior estimates. `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` Confidence/Credible Interval (CI) level. Default to `0.95` (`95%`). `nboot` Number of bootstrap samples for computing confidence interval for the effect size (Default: `100`). `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. `centrality.plotting` Logical that decides whether centrality tendency measure is to be displayed as a point with a label (Default: `TRUE`). Function decides which central tendency measure to show depending on the `type` argument. mean for parametric statistics median for non-parametric statistics trimmed mean for robust statistics MAP estimator for Bayesian statistics If you want default centrality parameter, you can specify this using `centrality.type` argument. `centrality.type` Decides which centrality parameter is to be displayed. The default is to choose the same as `type` argument. You can specify this to be: `"parameteric"` (for mean) `"nonparametric"` (for median) `robust` (for trimmed mean) `bayes` (for MAP estimator) Just as `type` argument, abbreviations are also accepted. `ggplot.component` A `ggplot` component to be added to the plot prepared by `ggstatsplot`. This argument is primarily helpful for `grouped_` variants of all primary functions. Default is `NULL`. The argument should be entered as a `ggplot2` function or a list of `ggplot2` functions. `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"`).

References

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

Examples

# for reproducibility
set.seed(123)
library(ggstatsplot)

# removing factor level with very few no. of observations
df <- dplyr::filter(.data = ggplot2::mpg, cyl %in% c("4", "6", "8"))

# plot
grouped_ggdotplotstats(
  data = df,
  x = cty,
  y = manufacturer,
  grouping.var = cyl,
  test.value = 15.5
)

ggstatsplot

'ggplot2' Based Plots with Statistical Details

v0.7.2

GPL-3 | file LICENSE

Authors

Indrajeet Patil [cre, aut, cph] (<https://orcid.org/0000-0003-1995-6531>, @patilindrajeets)

Initial release