strumSimModel-class: Class '"strumSimModel"'

In strum: STRUctural Modeling of Latent Variables for General Pedigree

Description

strumSimModel is an S4 class that contains the information of a trait model for simulation.

Objects from the Class

Objects should not be created by calls of the form new("strumSimModel", ...) but by the calls to the createSimModel function.

Slots

markerInfo:

Object of class "ANY" containing either a strumMarker object or NULL.

traitMissingRate:

Object of class "numeric" containing the missing rate(s) of the simulated traits in the model.

varList:

Object of class "data.frame" containing a list of variables and their properties.

formulas:

Object of class "character" containing the information about the formulas and dependencies.

allRandomEffects:

Object of class "character" listing all variance components in the model.

paramNames:

Object of class "character" describing the names of the model parameters.

ascertainment:

Object of class "ANY" stating the ascertainment criteria (function) of the data.

E:

Object of class "list" containing the variance matrices of measurement errors of the model.

Z:

Object of class "list" containing the variance matrices of random effects for the structural equation of the model.

L:

Object of class "function" to generate a matrix to relate the unobserved latent factors to the observed traits in the model.

B:

Object of class "function" to generate a matrix denoting the causal relationship among the latent factors in the model.

Gs:

Object of class "function" to generate a matrix to relate the observed covariates to the unobserved latent factors in the model.

Gm:

Object of class "function" to generate a matrix to relate the observed covariates to the observed traits in the model.

thToThB:

Object of class "numeric" for future use.

Extends

Class "strumVirtualModel", directly.

Methods

markerInfo

signature(object = "strumSimModel"): Accessor function, returns the markerInfo of the model.

traitMissingRate

signature(object = "strumSimModel"): Accessor function, returns the traitMissingRate of the model.

show

signature(object = "strumSimModel"): Print a summary of the model.

plot

signature(object = "strumSimModel", layoutType="dot",
    name="strumSimModel", toFile=TRUE, fileType="dot")

: Plot the model.

See Also

strumModel, strumVirtualModel, createSimModel

Examples

showClass("strumSimModel")

strum documentation built on May 2, 2019, 7:03 a.m.