is.angmcmc {BAMBI}

Angular MCMC (angmcmc) Object

Description

Checking for and creating an angmcmc object

Usage

is.angmcmc(object)

angmcmc(...)

Arguments

object

any R object

...

arguments required to make an angmcmc object. See details

Details

angmcmc objects are classified lists that are created when any of the five mixture model fitting functions, viz., fit_vmmix, fit_wnormmix, fit_vmsinmix, fit_vmcosmix and fit_wnorm2mix is used. An angmcmc object contains a number of elements, including the dataset, the model being fitted on the dataset and dimension of the model (univariate or bivariate), the tuning parameters used, MCMC samples for the mixture model parameters, the (hidden) component or cluster indicators for data points in each iteration and the (iteration-wise) log likelihood and log posterior density values (both calculated upto some normalizing constants). When printed, an angmcmc object returns a brief summary of the function arguments used to produce the object and the average acceptance rate of the proposals (in HMC and RWMH) used over iterations. An angmcmc object can be used as an argument for the diagnostic and post-processing functions available in BAMBI for making further inferences.

Value

logical. Is the input an angmcmc object?

Examples

# illustration only - more iterations needed for convergence
fit.vmsin.20 <- fit_vmsinmix(tim8, ncomp = 3, n.iter =  20,
                             n.chains = 1)
is.angmcmc(fit.vmsin.20)