compareMCMCs (version 0.6.0)

combineMetrics: Combine all metrics from a list of MCMCresult objects.

Description

This is useful for seeing results from multiple MCMC engines compactly.

Usage

combineMetrics(
  results,
  include_times = FALSE,
  params = NULL,
  paramFilter = NULL,
  MCMCs = NULL,
  MCMCFilter = NULL
)

Value

A list with elements byParameter, byMCMC and, if include_times=TRUE, times. Each element combines the corresponding elements for each MCMCresult object in the results argument.

Arguments

results

a list of MCMCresult objects

include_times

if TRUE, attempt to include timing elements in the combination.

params

Character vector of parameter names to include. If NULL, all available parameter results will be included.

paramFilter

Expression suitable for use in dplyr::filter to subset the parameters to include. The relevant column name of the data frame (to be passed to filter) is "Parameter". For example, paramFilter=Parameter %in% c("alpha", "beta") will include only alpha and beta. Subsetting parameters by the coarser params argument will be done before subsetting by paramFilter.

MCMCs

Character vector of MCMC names to include. If NULL, all available MCMCs will be included.

MCMCFilter

Expression suitable for use in dplyr::filter to subset the MCMCs to include. The relevant column name is "MCMC". For example,MCMCFilter=MCMC %in% c("MCMC1", "MCMC2") Subsetting parameters by the coarser MCMCs argument will be done before subsetting by MCMCFilter.

See Also

modifyMetrics