plot.brmsfit: Trace and Density Plots for MCMC Draws

Description Usage Arguments Value Examples

View source: R/plot.R

Description

Trace and Density Plots for MCMC Draws

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## S3 method for class 'brmsfit'
plot(
  x,
  pars = NA,
  combo = c("dens", "trace"),
  N = 5,
  variable = NULL,
  regex = FALSE,
  fixed = FALSE,
  theme = NULL,
  plot = TRUE,
  ask = TRUE,
  newpage = TRUE,
  ...
)

Arguments

x

An object of class brmsfit.

pars

Deprecated alias of variable. Names of the parameters to plot, as given by a character vector or a regular expression.

combo

A character vector with at least two elements. Each element of combo corresponds to a column in the resulting graphic and should be the name of one of the available MCMC functions (omitting the mcmc_ prefix).

N

The number of parameters plotted per page.

variable

Names of the variables (parameters) to plot, as given by a character vector or a regular expression (if regex = TRUE). By default, a hopefully not too large selection of variables is plotted.

regex

Logical; Indicates whether variable should be treated as regular expressions. Defaults to FALSE.

fixed

(Deprecated) Indicates whether parameter names should be matched exactly (TRUE) or treated as regular expressions (FALSE). Default is FALSE and only works with argument pars.

theme

A theme object modifying the appearance of the plots. For some basic themes see ggtheme and theme_default.

plot

Logical; indicates if plots should be plotted directly in the active graphic device. Defaults to TRUE.

ask

Logical; indicates if the user is prompted before a new page is plotted. Only used if plot is TRUE.

newpage

Logical; indicates if the first set of plots should be plotted to a new page. Only used if plot is TRUE.

...

Further arguments passed to mcmc_combo.

Value

An invisible list of gtable objects.

Examples

1
2
3
4
5
6
7
8
9
## Not run:  
fit <- brm(count ~ zAge + zBase * Trt 
           + (1|patient) + (1|visit), 
           data = epilepsy, family = "poisson")
plot(fit)
## plot population-level effects only
plot(fit, variable = "^b_", regex = TRUE) 

## End(Not run)

brms documentation built on Aug. 23, 2021, 5:08 p.m.