eRm: RSmpl – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

RSmpl

Sample Objects

Description

The objects of class RSmpl and RSmplext contain the original input matrix, the generated (encoded) random matrices, and some information about the sampling process.

Value

A list of class RSmpl or RSmplext with components

`n`	number of rows of the input matrix
`k`	number of columns of the input matrix
`inpmat`	the input matrix
`tfixed`	`TRUE`, if diagonals of `inpmat` are fixed
`burn_in`	length of the burn in process
`n_eff`	number of generated matrices (effective matrices)
`step`	controls the number number of void matrices generated in the the burn in process and when effective matrices are generated (see note in `rsctrl`).
`seed`	starting value for the random number generator
`n_tot`	number of matrices in `outvec`.
`outvec`	vector of encoded random matrices
`ier`	error code (see below)

Generation

These classes of objects are returned from rsampler and rsextrobj.

Methods

Both classes have methods for the generic summary function.

Note

By default, all generated matrices plus the original matrix (in position 1) are contained in outvec, thus n_tot = n_eff + 1. If the original matrix is not in outvec then n_tot = n_eff.

If ier is 0, no error was detected. Otherwise use the error function rserror(ier) to obtain some informations.

For saving and loading objects of class RSmpl or RSmplext see the example in rsextrobj.