Boom: pairs.density – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

pairs.density

Pairs plot for posterior distributions.

Description

A pairs plot showing the posterior distribution of the given list of Monte Carlo draws. Plots above the diagonal show the posterior distribution on a scale just wide enough to fit the plots. The diagonal shows a marginal density plot, and the subdiagonal shows the distribution with all plots on a common scale.

Usage

PairsDensity(draws,
             nlevels = 20,
             lty = NULL,
             color = NULL,
             subset = NULL,
             labels,
             legend.location = "top",
             legend.cex = 1,
             label.cex = 1,
             ...)

Arguments

`draws`	Either a matrix or a list of matrices. If a list is provided then each list element is plotted as a separate set of contours, and all matrices must have the same number of columns (though the number of rows can differ).
`nlevels`	The number of contour levels to plot.
`lty`	The line types to use for the different elements in `draws`.
`color`	The color to use for different elements in `draws`.
`subset`	If draws is a list, then this can be a numerical vector. If draws has names, then subset can be a character vector naming which elements to include. If `NULL` then all elements of `draws` are plotted.
`labels`	If `labels` is missing and the first element of draws has non-`NULL` `colnames` then these will be used to label the pairs plot. If a character vector of length `ncol(draws[[1]])` then this character vector will be used in place of the colnames. If `NULL` then no labels will be used.
`legend.location`	Either `"top"`, or `"right"` specifying the location for the legend, or `NULL`, indicating that no legend is desired. if draws is a matrix or a singleton list then no legend is produced.
`legend.cex`	Scale factor to use for the legend labels.
`label.cex`	Scale factor to use for the row and column labels.
`...`	Extra arguments (graphical parameters), passed to `plot`, `PlotDensityContours`, `axis`, and `AddExternalLegend`.

Author(s)

Steven L. Scott

Examples

## You can see the pairs plot for a single set of draws.
y <- matrix(rnorm(5000, mean = 1:5), ncol = 5, byrow = TRUE)
PairsDensity(y)

## You can also compare two or more sets of draws.
z <- matrix(rnorm(2500, mean = 2:6), ncol = 5, byrow = TRUE)
PairsDensity(list("first set" = y, "second set" = z))

Boom

Bayesian Object Oriented Modeling

v0.9.7

LGPL-2.1 | file LICENSE

Authors

Steven L. Scott is the sole author and creator of the BOOM project. Some code in the BOOM libraries has been modified from other open source projects. These include Cephes (obtained from Netlib, written by Stephen L. Moshier), NEWUOA (M.J.D Powell, obtained from Powell's web site), and a modified version of the R math libraries (R core development team). Original copyright notices have been maintained in all source files. In these cases, copyright claimed by Steven L. Scott is limited to modifications made to the original code. Google claims copyright for code written while Steven L. Scott was employed at Google from 2008 - 2018, but BOOM is not an officially supported Google project.

Initial release

2021-02-15