Grouped scatterplots from ggplot2
combined with marginal
histograms/boxplots/density plots with statistical details added as a
subtitle.
grouped_ggscatterstats(data, x, y, label.var = NULL,
label.expression = NULL, grouping.var, title.prefix = "Group",
xlab = NULL, ylab = NULL, method = "lm", method.args = list(),
formula = y ~ x, point.color = "black", point.size = 3,
point.alpha = 0.4, line.size = 1.5, point.width.jitter = NULL,
point.height.jitter = NULL, line.color = "blue", marginal = TRUE,
marginal.type = "histogram", marginal.size = 5, margins = c("both",
"x", "y"), package = "wesanderson", palette = "Royal1",
direction = 1, xfill = "#009E73", yfill = "#D55E00", xalpha = 1,
yalpha = 1, xsize = 0.7, ysize = 0.7, centrality.para = NULL,
type = "pearson", results.subtitle = TRUE, caption = NULL,
subtitle = NULL, nboot = 100, beta = 0.1, k = 3,
axes.range.restrict = FALSE, ggtheme = ggplot2::theme_bw(),
ggstatsplot.layer = TRUE, messages = TRUE, ...)
Dataframe from which variables specified are preferentially to be taken.
A vector containing the explanatory variable.
The response - a vector of length the number of rows of x
.
Variable to use for points labels. Must be entered as a
character string e.g. "y"
An expression evaluating to a logical vector that
determines the subset of data points to label. Must be entered as a
character string e.g. "y < 4 & z < 20"
.
Grouping variable.
Character specifying the prefix text for the fixed plot
title (name of each factor level) (Default: "Group"
).
Label for x
axis variable.
Label for y
axis variable.
Smoothing method (function) to use, accepts either a character vector,
e.g. "auto"
, "lm"
, "glm"
, "gam"
, "loess"
or a function, e.g.
MASS::rlm
or mgcv::gam
, base::lm
, or base::loess
.
For method = "auto"
the smoothing method is chosen based on the
size of the largest group (across all panels). loess()
is
used for less than 1,000 observations; otherwise mgcv::gam()
is
used with formula = y ~ s(x, bs = "cs")
. Somewhat anecdotally,
loess
gives a better appearance, but is \(O(N^{2})\) in memory,
so does not work for larger datasets.
If you have fewer than 1,000 observations but want to use the same gam()
model that method = "auto"
would use, then set
method = "gam", formula = y ~ s(x, bs = "cs")
.
List of additional arguments passed on to the modelling
function defined by method
.
Formula to use in smoothing function, eg. y ~ x
,
y ~ poly(x, 2)
, y ~ log(x)
Aesthetics specifying geom point
(defaults: point.color = "black"
, point.size = 3
,point.alpha = 0.4
).
Aesthetics specifying geom point
(defaults: point.color = "black"
, point.size = 3
,point.alpha = 0.4
).
Aesthetics specifying geom point
(defaults: point.color = "black"
, point.size = 3
,point.alpha = 0.4
).
Size for the regression line.
Degree of jitter in x
direction. Defaults to 40%
of the resolution of the data.
Degree of jitter in y
direction. Defaults to
40% of the resolution of the data.
color for the regression line.
Decides whether ggExtra::ggMarginal()
plots will be
displayed; the default is TRUE
.
Type of marginal distribution to be plotted on the axes
("histogram"
, "boxplot"
, "density"
, "violin"
, "densigram"
).
Integer describing the relative size of the marginal
plots compared to the main plot. A size of 5
means that the main plot is
5x wider and 5x taller than the marginal plots.
Character describing along which margins to show the plots.
Any of the following arguments are accepted: "both"
, "x"
, "y"
.
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.
Character describing color fill for x
and y
axes
marginal distributions (default: "#009E73"
(for x
) and "#D55E00"
(for
y
)). If set to NULL
, manual specification of colors will be turned off
and 2 colors from the specified palette
from package
will be selected.
Character describing color fill for x
and y
axes
marginal distributions (default: "#009E73"
(for x
) and "#D55E00"
(for
y
)). If set to NULL
, manual specification of colors will be turned off
and 2 colors from the specified palette
from package
will be selected.
Numeric deciding transparency levels for the marginal
distributions. Any numbers from 0
(transparent) to 1
(opaque). The
default is 1
for both axes.
Numeric deciding transparency levels for the marginal
distributions. Any numbers from 0
(transparent) to 1
(opaque). The
default is 1
for both axes.
Size for the marginal distribution boundaries (Default:
0.7
).
Size for the marginal distribution boundaries (Default:
0.7
).
Decides which measure of central tendency ("mean"
or "median"
) is to be displayed as vertical (for x
) and horizontal (for
y
) lines.
Type of association between paired samples required
(""parametric"
: Pearson's product moment correlation coefficient" or
""nonparametric"
: Spearman's rho" or ""robust"
: percentage bend
correlation coefficient"). Corresponding abbreviations are also accepted:
"p"
(for parametric/pearson's), "np"
(nonparametric/spearman), "r"
(robust), resp.
Decides whether the results of statistical tests are to be displayed as subtitle.
The text for the plot caption.
The text for the plot subtitle. Will work only if
results.subtitle = FALSE
.
Number of bootstrap samples for computing effect size (Default:
100
).
bending constant (Default: 0.1
). For more, see ?WRS2::pbcor
.
Number of decimal places expected for results.
Logical decides whether to restrict the axes
values ranges to min and max values of the x
and y
variables (Default:
FALSE
).
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_economist()
,
hrbrthemes::theme_ipsum_ps()
, ggthemes::theme_fivethirtyeight()
, etc.).
Logical that decides whether theme_ggstatsplot
theme elements are to be displayed along with the selected ggtheme
(Default: TRUE
).
Decides whether messages references, notes, and warnings are
to be displayed (Default: TRUE
).
Arguments passed on to combine_plots
String or plotmath expression to be drawn as title for the combined plot.
Text color for title.
Point size of title text.
Vertical justification for title. Default = 0.5
(centered
on y). 0
= baseline at y, 1 = ascender at y.
Horizontal justification for title. Default = 0.5
(centered on x). 0
= flush-left at x, 1
= flush-right.
The font face ("plain"
, "bold"
(default), "italic"
,
"bold.italic"
) for title.
String or plotmath expression to be drawn as the caption for the combined plot.
Text color for caption.
Point size of title text.
Vertical justification for caption. Default = 0.5
(centered on y). 0
= baseline at y, 1
= ascender at y.
Horizontal justification for caption. Default = 0.5
(centered on x). 0
= flush-left at x, 1
= flush-right.
The font face ("plain"
(default), "bold"
, "italic"
,
"bold.italic"
) for caption.
The label with which the combined plot should be annotated. Can be a plotmath expression.
Text color for annotation label (Default: "black"
).
Point size of annotation text (Default: 12
).
The x position of annotation label (Default: 0.5
).
The y position of annotation label (Default: 0.5
).
Horizontal justification for annotation label (Default:
0.5
).
Vertical justification for annotation label (Default:
0.5
).
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")
).
The font face ("plain"
(default), "bold"
, "italic"
,
"bold.italic"
) for the annotation label.
Angle at which annotation label is to be drawn (Default:
0
).
Line height of annotation label.
Numerical vector of relative columns heights while combining (title, plot, caption).
Numerical vector of relative columns heights while combining (title, plot).
Numerical vector of relative columns heights while combining (plot, caption).
https://cran.r-project.org/package=ggstatsplot/vignettes/ggscatterstats.html
# NOT RUN {
# to ensure reproducibility
set.seed(123)
# basic function call
ggstatsplot::grouped_ggscatterstats(
data = dplyr::filter(
ggstatsplot::movies_long,
genre == "Comedy" |
genre == "Drama"
),
x = length,
y = rating,
method = "lm",
formula = y ~ x + I(x^3),
grouping.var = genre
)
# using labeling
ggstatsplot::grouped_ggscatterstats(
data = dplyr::filter(ggplot2::mpg, cyl != 5),
x = displ,
y = hwy,
grouping.var = cyl,
title.prefix = "Cylinder count",
type = "robust",
label.var = "manufacturer",
label.expression = "hwy > 25 & displ > 2.5",
xfill = NULL,
package = "yarrr",
palette = "appletv",
messages = FALSE
)
# labeling without expression
# }
# NOT RUN {
ggstatsplot::grouped_ggscatterstats(
data = dplyr::filter(
.data = ggstatsplot::movies_long,
rating == 8,
genre %in% c("Drama", "Comedy")
),
x = budget,
y = length,
grouping.var = genre,
label.var = "title",
results.subtitle = FALSE,
marginal = FALSE,
title.prefix = "Genre",
caption.text = "All movies have IMDB rating greater than 8."
)
# }
Run the code above in your browser using DataCamp Workspace