Check MCMC objects

Source: R/chk.R

Checks class and structure of MCMC objects.

chk_mcmcarray checks if mcmcarray-object() object using

is.array(x) && is.numeric(x)

chk_mcmcr checks if an mcmcr-object().

chk_mcmcrs checks if an mcmcrs-object().

chk_mcmcarray(x, x_name = NULL)

chk_mcmcr(x, x_name = NULL)

chk_mcmcrs(x, x_name = NULL)

Arguments

x

The object to check.

x_name

A string of the name of object x or NULL.

Value

NULL, invisibly. Called for the side effect of throwing an error if the condition is not met.

Details

To just check class use chk::chk_s3_class().

Functions

  • chk_mcmcarray(): Check mcmcarray Object

  • chk_mcmcr(): Check mcmcr Object

  • chk_mcmcrs(): Check mcmcrs Object

See also

vld_mcmcr()

Examples


# chk_mcmcarray
try(chk_mcmcarray(1))
#> Error in chk_mcmcarray(1) : `1` must inherit from S3 class 'mcmcarray'.

# chk_mcmcr
chk_mcmcr(as.mcmcr(list(x = 1)))
try(chk_mcmcr(1))
#> Error in chk_mcmcr(1) : `1` must inherit from S3 class 'mcmcr'.

# chk_mcmcrs
chk_mcmcrs(as.mcmcrs(as.mcmcr(list(x = 1))))
try(chk_mcmcrs(1))
#> Error in chk_mcmcrs(1) : `1` must inherit from S3 class 'mcmcrs'.