ggstatsplot (version 0.0.5)

ggpiestats: Pie charts with statistical tests

Description

Pie charts for categorical data with statistical details included in the plot as a subtitle.

Usage

ggpiestats(data, main, condition = NULL, counts = NULL, ratio = NULL,
  paired = FALSE, factor.levels = NULL, stat.title = NULL,
  sample.size.label = TRUE, title = NULL, 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).

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).

title

The text for the plot title.

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.

k

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).

References

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

Examples

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

# simple function call with the defaults (with condition)
ggstatsplot::ggpiestats(
  data = datasets::mtcars,
  main = am,
  condition = cyl,
  nboot = 10
)

# simple function call with the defaults (without condition)
ggstatsplot::ggpiestats(
  data = iris,
  main = Species
)
# }