compare_points: Function 'compare_points'
In wlandau/fbseqDebug: fbseqDebug

Description Usage Arguments Value

Compare MCMC parameter samples of a single Chain with a named vector of point estimates. This is useful, for example, in simulation studies that begin with a set of "true" parameters. We can see if our 95% credible intervals recapture the truth.

1	compare_points(chain, points)

`chain`	`Chain` object
`points`	either a `Starts` object or a named numeric vector with names in `names(mcmc(chain))`. `Starts` objects will be automatically flattened into named numeric vectors.

A data frame with parameters as rows and the following columns.

pointsIn95ci: a matrix of logical values, each TRUE if and only if the parameter's starting value lies within the 95-percent credible interval estimated from the MCMC samples.
meansMinuspoints: mean of each parameter's MCMC samples (excluding burnin and thinning) minus that parameter's starting value.
mediansMinuspoints: The same as meansMinuspoints, but with medians