| registerMetrics {compareMCMCs} | R Documentation |
Register, unregister, or access registered MCMC metric functions
for use by compareMCMCs or addMetrics
Description
Register, unregister, or access registered MCMC metric functions
for use by compareMCMCs or addMetrics
Usage
registerMetrics(metrics)
unregisterMetric(name)
getMetrics()
Arguments
metrics |
A named list of new metric functions to register |
name |
Character name of a metric function to unregister |
Details
These functions are called for their "side effects" of
modifying the list metric functions for MCMC results that will
be recognized by name from the compareMCMCs or addMetrics
functions. Those functions take a metrics argument that can
be a character vector or a list. Names in the character vector
will be looked up from the registered metric functions.
registerMetrics takes a named list and adds its elements to the list
of recognized metrics with the corresponding names.
unregisterMetric removes one metric from the list at a time.
getMetrics returns the list of registered metrics.
Value
registerMetrics and getMetrics return the environment of
registered metrics.
unregisterMetric returns the result (which should be NULL) of a
call to rm that attempts to remove a metric.