strumIBD-class: Class '"strumIBD"'

Description Objects from the Class Slots Methods See Also Examples

Description

strumIBD is an S4 class that represents IBD information of the input data for a STRUctural Modeling of latent Variables for family data.

Objects from the Class

Objects can be created by calls of the form new("strumIBD", ...) or by the importIBD method in strumData class.

Slots

ibdMarker:

Object of class "data.frame" containing the information about the markers. Typically contains two columns, "Marker" and "Position".

ibdMatrix:

Object of class "list" containing the lists of identical by descent (ibd) matrices, for each family and marker.

Methods

ibdMarker

signature(object = "strumIBD"): Accessor function, returns the marker information.

ibdMatrix

signature(object = "strumIBD"): Accessor function, returns the list of ibd matrices of the input data.

show

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

See Also

strumSimModel, strumData

Examples

1
showClass("strumIBD")

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