strumData-class: Class '"strumData"'

Description Objects from the Class Slots Methods See Also Examples

Description

strumData is an S4 class that contains the input data for a STRUctural Modeling of latent variables for family data.

Objects from the Class

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

Slots

dataType:

Character stating the type of input data, must be "Pedigrees" or "RawData"

dataVals:

Object of class data.frame containing input data.

phi:

Object of class "list" containing the kinship matrices for each pedigree. This is empty if the dataType is not "Pedigree".

ibd:

Object of class "strumIBD" containing the IBD information for input pedigrees. This is empty if the dataType is not "Pedigree".

Methods

importIBD

signature(object = "strumData", fileName, fileType="SAGE"): Import the ibd information of the input data.

show

signature(object = "strumData"): Print a summary of the class.

See Also

strumIBD, createStrumData, simulateStrumData

Examples

1
showClass("strumData")

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