make_MCMC_comparison_pages {compareMCMCs}

Create html output with comparisons of MCMC results

Description

Create html output with comparisons of MCMC results

Usage

make_MCMC_comparison_pages(
  comparisonResults,
  dir = tempdir(),
  pageComponents,
  modelName = "model",
  control,
  plot = TRUE
)

Arguments

comparisonResults

An list of MCMCresult objects such as returned by compareMCMCs.

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 dir = getwd() to use current working directory.

pageComponents

A list whose names are registered page components and values are TRUE (to include a component) or FALSE (to omit a component). Components can also be omitted by leaving them out of the list.

modelName

A name to be used for the model in generated output.

control

A named list of control parameters.

plot

TRUE to generate results, FALSE not to do so. Use of FALSE is useful if one wants to use the returned object (including plottable components) in one's own way.

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()).

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.