idealToMCMC: convert an object of class ideal to a coda MCMC object

Description Usage Arguments Value Note See Also Examples

View source: R/toMCMC.r

Description

Converts the x element of an ideal object to an MCMC object, as used in the coda package.

Usage

1
idealToMCMC(object, burnin=NULL)

Arguments

object

an object of class ideal.

burnin

of the recorded MCMC samples, how many to discard as burnin? Default is NULL, in which case the value of burnin in the ideal object is used.

Value

A mcmc object as used by the coda package, starting at iteration start, drawn from the x component of the ideal object.

Note

When specifying a value of burnin different from that used in fitting the ideal object, note a distinction between the iteration numbers of the stored iterations, and the number of stored iterations. That is, the n-th iteration stored in an ideal object will not be iteration n if the user specified thin>1 in the call to ideal. Here, iterations are tagged with their iteration number. Thus, if the user called ideal with thin=10 and burnin=100 then the stored iterations are numbered 100, 110, 120, .... Any future subsetting via a burnin refers to this iteration number.

See Also

ideal, mcmc

Examples

1
2
3
4
5
data(s109)
f = system.file("extdata",package="pscl","id1.rda")
load(f)
id1coda <- idealToMCMC(id1)
summary(id1coda)  

pscl documentation built on March 26, 2020, 7:36 p.m.