chk_mcmcr: Check MCMC objects

In poissonconsulting/mcmcr: Manipulate MCMC Samples

Check MCMC objects

Description

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

Usage

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.

Details

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

Value

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

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

# chk_mcmcr
chk_mcmcr(as.mcmcr(list(x = 1)))
try(chk_mcmcr(1))

# chk_mcmcrs
chk_mcmcrs(as.mcmcrs(as.mcmcr(list(x = 1))))
try(chk_mcmcrs(1))

poissonconsulting/mcmcr documentation built on Jan. 18, 2024, 1:11 a.m.