ggstatsplot (version 0.0.3)

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(grouping.var, title.prefix = "Group", data, main,
  condition = NULL, factor.levels = NULL, stat.title = NULL,
  caption = NULL, legend.title = NULL, facet.wrap.name = NULL, k = 3,
  facet.proptest = TRUE, messages = TRUE, ...)

Arguments

grouping.var

Grouping variable.

title.prefix

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

data

The data as a data frame.

main

A string naming the variable to use as the rows in the contingency table.

condition

A string naming the variable to use as the columns in the contingency table.

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.

caption

The text for the plot caption.

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 proprotion test for main variable is to be carried out for each level of condition (Default: TRUE).

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", etc.) 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", "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.

sub.size

Point size of annotation text.

sub.x

The x position of annotation label.

sub.y

The y position of annotation label.

sub.hjust

Horizontal justification for annotation label.

sub.vjust

Vertical justification for annotation label.

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.

sub.fontface

The font face ("plain", "bold", "italic", "bold.italic") for the annotation label.

sub.angle

Angle at which annotation label is to be drawn.

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

See Also

ggpiestats

Examples

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

# }