strumVirtualModel-class: Class '"strumVirtualModel"'

In strum: STRUctural Modeling of Latent Variables for General Pedigree

Description

The strumVirtualModel class is a virtual class to represent a STRUctural Modeling of latent Variables for family data. It contains a description of the model as specified by the user through the model formulas and an set of functions to construct the internal matrix representation of the model.

Objects from the Class

A virtual Class: No objects may be created from it.

Slots

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.

Methods

formulas

signature(object = "strumVirtualModel"): Accessor function, returns the formulas of the model.

formulas<-

signature(object = "strumVirtualModel", value): Modifier function, sets the formulas of the model with a given value.

covariatePhenotypes

signature(object = "strumVirtualModel"): Accessor function, returns the names of covariate phenotypes of the model.

varList

signature(object = "strumVirtualModel"): Accessor function, returns the variable list of the model as a data.frame.

varList<-

signature(object = "strumVirtualModel", value): Modifier function, sets the variable list of the model with a given value.

allRandomEffects

signature(object = "strumVirtualModel"): Accessor function, returns the names of all random effects of the model.

allRandomEffects<-

signature(object = "strumVirtualModel", value): Modifier function, sets the allRandomEffects of the model with a given value.

paramNames

signature(object = "strumVirtualModel"): Accessor function, returns the names of all parameters of the model.

paramNames<-

signature(object = "strumVirtualModel", value): Modifier function, sets the paramNames of the model with a given value.

ascertainment

signature(object = "strumVirtualModel"): Accessor function, returns the ascertainment definition of the model.

ascertainment<-

signature(object = "strumVirtualModel", value): Modifier function, sets the ascertainment of the model with a given value.

show

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

plot

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

: Plot the model.

See Also

strumModel, strumSimModel

Examples

showClass("strumVirtualModel")

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