make_MCMC_comparison_pages {compareMCMCs} | R Documentation |
Create html output with comparisons of MCMC results
Description
Create html output with comparisons of MCMC results
Usage
make_MCMC_comparison_pages(
results,
dir = tempdir(),
pageComponents,
modelName = "model",
control,
params = NULL,
paramFilter = NULL,
MCMCs = NULL,
MCMCFilter = NULL,
plot = TRUE
)
Arguments
results |
A list of |
dir |
A directory in which to place the html file and any
figure files used in it. This defaults to tempdir() (which
will be erased when the R session is closed).
Use |
pageComponents |
A list whose names are registered page
components and values are |
modelName |
A name to be used for the model in generated output. |
control |
A named list of control parameters. |
params |
Character vector of parameter names to include. If |
paramFilter |
Expression suitable for use in |
MCMCs |
Character vector of MCMC names to include. If |
MCMCFilter |
Expression suitable for use in |
plot |
|
Details
See package vignette for information about page components, including about default page components and how to write and register new page components.
To see built-in page components and their options, use
as.list(getPageComponents())
.
The arguments params
, paramFilter
, MCMCs
, and
MCMCFilter
are passed to combineMetrics
. Both
paramFilter
and MCMCFilter
are passed as expressions. One can
call combineMetrics
directly (with results
as the first argument and any
of these four arguments) to see the results tables that will be used to
create figures.
Value
A list of objects returned from each page component plugin. For figures,
these contain a plottable
object such as a ggplot
object. For text,
these contain information for text output such as an xtable
object.