rv (version 1.0)

sims: Retrieve the Simulations of Random Vectors

Description

Returns the simulation matrix for the random variable object x.

Usage

sims(x, ...)
 ## S3 method for class 'default':
sims(x, \dots)
 ## S3 method for class 'rv':
sims(x, dimensions=FALSE, n.sims=getnsims(), ...)
 ## S3 method for class 'rvsummary':
sims(x, dimensions=FALSE, \dots)

Arguments

x

a random variable object

n.sims

(optional) number of simulations

dimensions

logical, try to preserve the dimensions of x

...

arguments passed on

Details

sims returns the matrix of simulations for a given random variable object x.

The first index of the matrix indicates the number of the simulation draw (``simulations are in rows").

References

Kerman, J. and Gelman, A. (2007). Manipulating and Summarizing Posterior Simulations Using Random Variable Objects. Statistics and Computing 17:3, 235-244.

See also vignette("rv").

Examples

setnsims(n.sims=2500)
  x <- rvnorm(24)
  dim(x) <- c(2,3,4)
  dim(sims(x))                  # 2500x24
  dim(sims(x, dimensions=TRUE)) # 2500x2x3x4