ggscatterstats: Scatterplot with marginal distributions and statistical...

View source: R/ggscatterstats.R

ggscatterstatsR Documentation

Scatterplot with marginal distributions and statistical results


Scatterplots from {ggplot2} combined with marginal densigram (density + histogram) plots with statistical details.


  type = "parametric",
  conf.level = 0.95,
  bf.prior = 0.707,
  bf.message = TRUE,
  tr = 0.2,
  k = 2L,
  results.subtitle = TRUE,
  label.var = NULL,
  label.expression = NULL,
  marginal = TRUE,
  xfill = "#009E73",
  yfill = "#D55E00",
  point.args = list(size = 3, alpha = 0.4, stroke = 0, na.rm = TRUE),
  point.width.jitter = 0,
  point.height.jitter = 0,
  point.label.args = list(size = 3, max.overlaps = 1e+06),
  smooth.line.args = list(size = 1.5, color = "blue", method = "lm", formula = y ~ x,
    na.rm = TRUE),
  xsidehistogram.args = list(fill = xfill, color = "black", na.rm = TRUE),
  ysidehistogram.args = list(fill = yfill, color = "black", na.rm = TRUE),
  xlab = NULL,
  ylab = NULL,
  title = NULL,
  subtitle = NULL,
  caption = NULL,
  ggtheme = ggstatsplot::theme_ggstatsplot(),
  ggplot.component = NULL,
  output = "plot",



A data frame (or a tibble) from which variables specified are to be taken. Other data types (e.g., matrix,table, array, etc.) will not be accepted. Additionally, grouped data frames from {dplyr} should be ungrouped before they are entered as data.


The column in data containing the explanatory variable to be plotted on the x-axis.


The column in data containing the response (outcome) variable to be plotted on the y-axis.


A character specifying the type of statistical approach:

  • "parametric"

  • "nonparametric"

  • "robust"

  • "bayes"

You can specify just the initial letter.


Scalar between 0 and 1. If unspecified, the defaults return 95% confidence/credible intervals (0.95).


A number between 0.5 and 2 (default 0.707), the prior width to use in calculating Bayes factors and posterior estimates. In addition to numeric arguments, several named values are also recognized: "medium", "wide", and "ultrawide", corresponding to r scale values of 1/2, sqrt(2)/2, and 1, respectively. In case of an ANOVA, this value corresponds to scale for fixed effects.


Logical that decides whether to display Bayes Factor in favor of the null hypothesis. This argument is relevant only for parametric test (Default: TRUE).


Trim level for the mean when carrying out robust tests. In case of an error, try reducing the value of tr, which is by default set to 0.2. Lowering the value might help.


Number of digits after decimal point (should be an integer) (Default: k = 2L).


Decides whether the results of statistical tests are to be displayed as a subtitle (Default: TRUE). If set to FALSE, only the plot will be returned.


Variable to use for points labels entered as a symbol (e.g. var1).


An expression evaluating to a logical vector that determines the subset of data points to label (e.g. y < 4 & z < 20). While using this argument with purrr::pmap, you will have to provide a quoted expression (e.g. quote(y < 4 & z < 20)).


Decides whether marginal distributions will be plotted on axes using ggside functions. The default is TRUE. The package ggside must already be installed by the user.

xfill, yfill

Character describing color fill for x and y axes marginal distributions (default: "#009E73" (for x) and "#D55E00" (for y)). Note that the defaults are colorblind-friendly.


A list of additional aesthetic arguments to be passed to geom_point geom used to display the raw data points.

point.width.jitter, point.height.jitter

Degree of jitter in x and y direction, respectively. Defaults to 0 (0%) of the resolution of the data. Note that the jitter should not be specified in the point.args because this information will be passed to two different geoms: one displaying the points and the other displaying the *labels for these points.


A list of additional aesthetic arguments to be passed to ggrepel::geom_label_repel geom used to display the labels.


A list of additional aesthetic arguments to be passed to geom_smooth geom used to display the regression line.

xsidehistogram.args, ysidehistogram.args

A list of arguments passed to respective geom_s from ggside package to change the marginal distribution histograms plots.


Label for x axis variable. If NULL (default), variable name for x will be used.


Labels for y axis variable. If NULL (default), variable name for y will be used.


The text for the plot title.


The text for the plot subtitle. Will work only if results.subtitle = FALSE.


The text for the plot caption. This argument is relevant only if bf.message = FALSE.


A {ggplot2} theme. Default value is ggstatsplot::theme_ggstatsplot(). Any of the {ggplot2} themes (e.g., theme_bw()), or themes from extension packages are allowed (e.g., ggthemes::theme_fivethirtyeight(), hrbrthemes::theme_ipsum_ps(), etc.). But note that sometimes these themes will remove some of the details that {ggstatsplot} plots typically contains. For example, if relevant, ggbetweenstats() shows details about multiple comparison test as a label on the secondary Y-axis. Some themes (e.g. ggthemes::theme_fivethirtyeight()) will remove the secondary Y-axis and thus the details as well.


A ggplot component to be added to the plot prepared by {ggstatsplot}. This argument is primarily helpful for grouped_ variants of all primary functions. Default is NULL. The argument should be entered as a {ggplot2} function or a list of {ggplot2} functions.


Character that describes what is to be returned: can be "plot" (default) or "subtitle" or "caption". Setting this to "subtitle" will return the expression containing statistical results. If you have set results.subtitle = FALSE, then this will return a NULL. Setting this to "caption" will return the expression containing details about Bayes Factor analysis, but valid only when type = "parametric" and bf.message = TRUE, otherwise this will return a NULL.


Currently ignored.


For details, see:


The plot uses ggrepel::geom_label_repel to attempt to keep labels from over-lapping to the largest degree possible. As a consequence plot times will slow down massively (and the plot file will grow in size) if you have a lot of labels that overlap.

See Also

grouped_ggscatterstats, ggcorrmat, grouped_ggcorrmat


# to get reproducible results from bootstrapping
library(dplyr, warn.conflicts = FALSE)

# creating dataframe with rownames converted to a new column
mtcars_new <- as_tibble(mtcars, rownames = "car")

# simple function call with the defaults
if (require("ggside")) {
    data = mtcars_new,
    x = wt,
    y = mpg,
    label.var = car,
    label.expression = wt < 4 & mpg < 20
  ) + # making further customization with `{ggplot2}` functions
    geom_rug(sides = "b")

ggstatsplot documentation built on May 21, 2022, 5:05 p.m.