converg: Graph of Running Statistics for Convergence Diagnostics

In mc2d: Tools for Two-Dimensional Monte-Carlo Simulations

Graph of Running Statistics for Convergence Diagnostics

Description

Provides basic graphs to evaluate the convergence of a node of a mc or a mccut object in the variability or in the uncertainty dimension.

Usage

converg(
  x,
  node = length(x),
  margin = c("var", "unc"),
  nvariates = 1,
  iter = 1,
  probs = c(0.025, 0.975),
  lim = c(0.025, 0.975),
  griddim = NULL,
  log = FALSE
)

Arguments

x	a mcnode, mc or mccut object.
node	the node to be considered in a ‘⁠mc⁠’ or ‘⁠mccut⁠’ object, either as order number or name. By default: the last node. Cannot be of type ‘⁠"0"⁠’.
margin	the margin used to plot the graph. Used only if the node is a ‘⁠"VU"⁠’ node.
nvariates	the variate to be considered. Used only for multivariate nodes.
iter	if ‘⁠margin=="var"⁠’ and the node is ‘⁠"VU"⁠’, specifies which iteration in the uncertainty dimension to use.
probs	the quantiles to be provided in the variability dimension.
lim	the quantiles to be used in the uncertainty dimension.
griddim	a vector of two integers for the grid size. If ‘⁠NULL⁠’, calculated automatically.
log	if ‘⁠TRUE⁠’, the data will be log-transformed.

Details

If the node is of type ‘⁠"V"⁠’, the running mean, median and ‘⁠probs⁠’ quantiles according to the variability dimension will be provided. If the node is of type ‘⁠"VU"⁠’ and ‘⁠margin="var"⁠’, this graph will be provided on one simulation in the uncertainty dimension (chosen by ‘⁠iter⁠’).

If the node is of type ‘⁠"U"⁠’, the running mean, median and ‘⁠lim⁠’ quantiles according to the uncertainty dimension will be provided.

If the node is of type ‘⁠"VU"⁠’ (with ‘⁠margin="unc"⁠’ or from a ‘⁠mccut⁠’ object), one graph is provided for each of the mean, median and ‘⁠probs⁠’ quantiles calculated in the variability dimension.

Value

‘⁠invisible(NULL)⁠’ (called for its side effect of drawing a plot).

Note

This function may be used on a ‘⁠mccut⁠’ object only if a ‘⁠summary.mc⁠’ function was used in the third block of the evalmccut call. The values used as ‘⁠probs⁠’ in ‘⁠converg⁠’ should have been used in that ‘⁠summary.mc⁠’.

Examples

data(total)
converg(xVU, margin="var")
converg(xVU, margin="unc")

mc2d documentation built on Oct. 23, 2026, 1:06 a.m.