grouped_ggpiestats: Grouped pie charts with statistical tests

Description

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

Usage

grouped_ggpiestats(data, main, condition = NULL, counts = NULL,
  grouping.var, title.prefix = "Group", ratio = NULL, paired = FALSE,
  factor.levels = NULL, stat.title = NULL, sample.size.label = TRUE,
  caption = NULL, nboot = 25, palette = "Dark2",
  legend.title = NULL, facet.wrap.name = NULL, k = 3,
  facet.proptest = TRUE, ggtheme = ggplot2::theme_bw(),
  messages = TRUE, ...)

Arguments

data

The data as a data frame (matrix or tables will not be accepted).

main

The variable to use as the rows in the contingency table.

condition

The variable to use as the columns in the contingency table. This argument is optional (Default: NULL). If this argument is provided, then Pearson's chi-square test of independence will be run. If not, a goodness of fit test will be run on the main variable.

counts

A string naming a variable in data containing counts, or NULL if each row represents a single observation (Default).

grouping.var

Grouping variable.

title.prefix

Character specifying the prefix text for the fixed plot title (name of each factor level) (Default: "Group").

ratio

A vector of numbers: the expected proportions for the proportion test. Default is NULL, which means if there are two levels ratio = c(1,1), etc.

paired

A logical indicating whether to consider the values as paired. If paired = FALSE (default), details from Pearson's chi-square test of independence will be displayed. If paired = TRUE, details from McNemar's test will be displayed.

factor.levels

A character vector with labels for factor levels of main variable.

stat.title

Title for the effect being investigated with the chi-square test. The default is NULL, i.e. no title will be added to describe the effect being shown. An example of a stat.title argument will be something like "main x condition" or "interaction".

sample.size.label

Logical that decides whether sample size information should be displayed for each level of the grouping variable condition (Default: TRUE).

caption

The text for the plot caption.

nboot

Number of bootstrap samples for computing effect size (Default: 25).

palette

If a character string (e.g., "Set1"), will use that named palette. If a number, will index into the list of palettes of appropriate type. Default palette is "Dark2"

legend.title

Title of legend.

facet.wrap.name

The text for the facet_wrap variable label.

Number of decimal places expected for results.

facet.proptest

Decides whether proportion test for main variable is to be carried out for each level of condition (Default: TRUE).

ggtheme

A function, ggplot2 theme name. Default value is ggplot2::theme_bw(). Allowed values are the official ggplot2 themes, including theme_grey(), theme_minimal(), theme_classic(), theme_void(), etc.

messages

Decides whether messages references, notes, and warnings are to be displayed (Default: TRUE).

...

Arguments passed on to combine_plots

title.text: String or plotmath expression to be drawn as title for the combined plot.
title.color: Text color for title.
title.size: Point size of title text.
title.vjust: Vertical justification for title. Default = 0.5 (centered on y). 0 = baseline at y, 1 = ascender at y.
title.hjust: Horizontal justification for title. Default = 0.5 (centered on x). 0 = flush-left at x, 1 = flush-right.
title.fontface: The font face ("plain", "bold" (default), "italic", "bold.italic") for title.
caption.text: String or plotmath expression to be drawn as the caption for the combined plot.
caption.color: Text color for caption.
caption.size: Point size of title text.
caption.vjust: Vertical justification for caption. Default = 0.5 (centered on y). 0 = baseline at y, 1 = ascender at y.
caption.hjust: Horizontal justification for caption. Default = 0.5 (centered on x). 0 = flush-left at x, 1 = flush-right.
caption.fontface: The font face ("plain" (default), "bold", "italic", "bold.italic") for caption.
sub.text: The label with which the combined plot should be annotated. Can be a plotmath expression.
sub.color: Text color for annotation label (Default: "black").
sub.size: Point size of annotation text (Default: 12).
sub.x: The x position of annotation label (Default: 0.5).
sub.y: The y position of annotation label (Default: 0.5).
sub.hjust: Horizontal justification for annotation label (Default: 0.5).
sub.vjust: Vertical justification for annotation label (Default: 0.5).
sub.vpadding: Vertical padding. The total vertical space added to the label, given in grid units. By default, this is added equally above and below the label. However, by changing the y and vjust parameters, this can be changed (Default: grid::unit(1, "lines")).
sub.fontface: The font face ("plain" (default), "bold", "italic", "bold.italic") for the annotation label.
sub.angle: Angle at which annotation label is to be drawn (Default: 0).
sub.lineheight: Line height of annotation label.
title.caption.rel.heights: Numerical vector of relative columns heights while combining (title, plot, caption).
title.rel.heights: Numerical vector of relative columns heights while combining (title, plot).
caption.rel.heights: Numerical vector of relative columns heights while combining (plot, caption).

References

https://indrajeetpatil.github.io/ggstatsplot/articles/ggpiestats.html

Examples

Run this code

# NOT RUN {
# grouped one-sample proportion tests
ggstatsplot::grouped_ggpiestats(
  data = mtcars,
  grouping.var = am,
  main = cyl
)
# }

Run the code above in your browser using DataLab

Description

Usage

Arguments

References

See Also

Examples