Bivariate bar charts for nominal and ordinal data with (optionally) statistical details included in the plot as a subtitle.
PlotXTabs2(
data,
x,
y,
counts = NULL,
results.subtitle = TRUE,
title = NULL,
subtitle = NULL,
caption = NULL,
plottype = "percent",
xlab = NULL,
ylab = "Percent",
legend.title = NULL,
legend.position = "right",
labels.legend = NULL,
sample.size.label = TRUE,
data.label = "percentage",
label.text.size = 4,
label.fill.color = "white",
label.fill.alpha = 1,
bar.outline.color = "black",
x.axis.orientation = NULL,
conf.level = 0.95,
k = 2,
perc.k = 0,
mosaic.offset = 0.003,
mosaic.alpha = 1,
bf.details = FALSE,
bf.display = "regular",
sampling.plan = "jointMulti",
fixed.margin = "rows",
prior.concentration = 1,
paired = FALSE,
ggtheme = ggplot2::theme_bw(),
package = "RColorBrewer",
palette = "Dark2",
direction = 1,
ggplot.component = NULL
)A dataframe or tibble containing the `x` and `y` variables.
The variable to plot on the X axis of the chart.
The variable to segment the **columns** and test for independence.
If the dataframe is based upon counts rather than individual rows for observations, `counts` must contain the name of variable that contains the counts. See `HairEyeColor` example.
Decides whether the results of statistical tests are displayed as a subtitle (Default: TRUE). If set to FALSE, no subtitle.
The text for the plot title.
The text for the plot subtitle. **N.B** if statistical results are requested through `results.subtitle = TRUE` the results will have precedence.
The text for the plot caption. Please note the interaction with `bf.details`.
one of four options "side", "stack", "mosaic" or "percent"
Custom text for the `x` axis label (Default: `NULL`, which will cause the `x` axis label to be the `x` variable).
Custom text for the `y` axis label (Default: `"Percent"`). Set to `NULL` for no label.
Title text for the legend.
The position of the legend `"none"`, `"left"`, `"right"`, `"bottom"`, `"top"` (Default: `"right"`).
A character vector with custom labels for levels of the `y` variable displayed in the legend.
Logical that decides whether sample size information should be displayed for each level of the grouping variable `y` (Default: `TRUE`).
Character decides what information needs to be displayed on the label in each bar segment. Possible options are `"percentage"` (default), `"counts"`, `"both"`.
Numeric that decides size for bar labels (Default: `4`).
Character that specifies fill color for bar labels (Default: `white`).
Numeric that specifies fill color transparency or `"alpha"` for bar labels (Default: `1` range `0` to `1`).
Character specifying color for bars (default: `"black"`).
The orientation of the `x` axis labels one of "slant" or "vertical" to change from the default horizontal orientation (Default: `NULL` which is horizontal).
Scalar between 0 and 1. If unspecified, the defaults return lower and upper confidence intervals (0.95).
Number of digits after decimal point (should be an integer) (Default: k = 2) for statistical results.
Numeric that decides number of decimal places for percentage labels (Default: `0`).
Numeric that decides size of spacing between mosaic blocks (Default: `.003` which is very narrow). "reasonable" values probably lie between .05 and .001
Numeric that controls the "alpha" level of the mosaic plot blocks (Default: `1` which is essentially no "fading"). Values must be in the range 0 to 1 see: `ggplot2::aes_colour_fill_alpha`
Logical that decides whether to display additional information from the Bayes Factor test in the caption (default:`FALSE`). This will take precedence over any text you enter as a `caption`.
Character that determines how the Bayes factor value is is displayed. The default is simply the number rounded to `k`. Other options include "sensible", "log" and "support".
the sampling plan (see details in ?contingencyTableBF).
(see details in ?contingencyTableBF).
(see details in ?contingencyTableBF).
Not used yet.
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., hrbrthemes::theme_ipsum(), etc.).
Name of package from which the palette is desired as string or symbol.
Name of palette as string or symbol.
Either `1` or `-1`. If `-1` the palette will be reversed.
A ggplot component to be added to the plot prepared by ggstatsplot. Default is NULL. The argument should be entered as a function. If the given function has an argument axes.range.restrict and if it has been set to TRUE, the added ggplot component might not work as expected.
# NOT RUN {
# for reproducibility
set.seed(123)
# simplest possible call with the defaults
PlotXTabs2(
data = mtcars,
y = vs,
x = cyl
)
# more complex call
PlotXTabs2(
data = datasets::mtcars,
y = vs,
x = cyl,
bf.details = TRUE,
labels.legend = c("0 = V-shaped", "1 = straight"),
legend.title = "Engine Style",
legend.position = "right",
title = "The perenial mtcars example",
palette = "Pastel1"
)
PlotXTabs2(
data = as.data.frame(HairEyeColor),
y = Eye,
x = Hair,
counts = Freq
)
# }
# NOT RUN {
# mosaic plot requires ggmosaic 0.2.2 or higher from github
PlotXTabs2(
data = mtcars,
x = vs,
y = am,
plottype = "mosaic",
data.label = "both",
mosaic.alpha = .9,
bf.display = "support",
title = "Motorcars Mosaic Plot VS by AM"
)
# }
# NOT RUN {
# }
Run the code above in your browser using DataLab