rv (version 2.3.4)

sims: Retrieve the Simulations of Random Vectors

Description

Returns the simulation matrix for the random variable object x.

Usage

sims(x, ...)
# S3 method for rvsummary
sims(x, dimensions = FALSE, ...)
# S3 method for rv
sims(x, dimensions = FALSE, n.sims = getnsims(), ...)

Arguments

x

a random variable object

…

arguments passed on

dimensions

logical, try to preserve the dimensions of x

n.sims

(optional) number of simulations

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

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

# }