Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free
Documentation
R
gratia

draw.smooth_samples

Plot posterior smooths

Description

Plot posterior smooths

Usage

## S3 method for class 'smooth_samples'
draw(
  object,
  select = NULL,
  xlab = NULL,
  ylab = NULL,
  title = NULL,
  subtitle = NULL,
  caption = NULL,
  alpha = 1,
  colour = "black",
  scales = c("free", "fixed"),
  rug = TRUE,
  partial_match = FALSE,
  ncol = NULL,
  nrow = NULL,
  guides = "keep",
  ...
)

Arguments

object

a fitted GAM, the result of a call to mgcv::gam().
select

character, logical, or numeric; which smooths to plot. If NULL, the default, then all model smooths are drawn. Numeric select indexes the smooths in the order they are specified in the formula and stored in object. Character select matches the labels for smooths as shown for example in the output from summary(object). Logical select operates as per numeric select in the order that smooths are stored.
xlab

character or expression; the label for the x axis. If not supplied, a suitable label will be generated from object.
ylab

character or expression; the label for the y axis. If not supplied, a suitable label will be generated from object.
title

character or expression; the title for the plot. See ggplot2::labs().
subtitle

character or expression; the subtitle for the plot. See ggplot2::labs().
caption

character or expression; the plot caption. See ggplot2::labs().
alpha

numeric; alpha transparency for confidence or simultaneous interval.
colour

The colour to use to draw the posterior smooths. Passed to ggplot2::geom_line() as argument colour.
scales

character; should all univariate smooths be plotted with the same y-axis scale? The default, scales = "fixed", ensures this is done. If scales = "free" each univariate smooth has its own y-axis scale. Currently does not affect the y-axis scale of plots of the parametric terms.
rug

logical; draw a rug plot at the botom of each plot?
partial_match

logical; should smooths be selected by partial matches with select? If TRUE, select can only be a single string to match against.
ncol

numeric; the numbers of rows and columns over which to spread the plots
nrow

numeric; the numbers of rows and columns over which to spread the plots
guides

character; one of "keep" (the default), "collect", or "auto". Passed to patchwork::plot_layout()
...

arguments to be passed to patchwork::wrap_plots().

Author(s)

Gavin L. Simpson

Examples

load_mgcv()

dat1 <- gamSim(1, n = 400, dist = "normal", scale = 2, verbose = FALSE)
## a single smooth GAM
m1 <- gam(y ~ s(x0) + s(x1) + s(x2) + s(x3), data = dat1, method = "REML")
## posterior smooths from m1
sm1 <- smooth_samples(m1, n = 15, seed = 23478)
## plot
draw(sm1, alpha = 0.7)


dat2 <- gamSim(4, verbose = FALSE)
## a multi-smooth GAM with a factor-by smooth
m2 <- gam(y ~ fac + s(x2, by = fac) + s(x0), data = dat2, method = "REML")
## posterior smooths from m1
sm2 <- smooth_samples(m2, n = 15, seed = 23478)
## plot, this time selecting only the factor-by smooth
draw(sm2, select = "s(x2)", partial_match = TRUE, alpha = 0.7)
gratia

Graceful 'ggplot'-Based Graphics and Other Functions for GAMs Fitted Using 'mgcv'

v0.6.0
MIT + file LICENSE
Authors
Gavin L. Simpson [aut, cre] (<https://orcid.org/0000-0002-9084-8413>), Henrik Singmann [ctb] (<https://orcid.org/0000-0002-4842-3657>)
Initial release
2021-04-17

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.