strum (version 0.2)

strum: STRUctural Modeling of Latent Variables for Family Data

Description

Main function to run strum analysis and return the result as a (list of) strumFittedModel.

Usage

strum(myStrumModel, myStrumData, ibdMarkers=NULL)

Arguments

myStrumModel

Object of class strumModel.

myStrumData

Object of class strumData.

ibdMarkers

Character vector contaning the name of marker(s) for additive genetic variance component a (see Details).

Value

• Returns a (list of) strumFittedModel object.

Details

Note that if the analysis model includes an additive genetic variance component a for the random effects, the value of iMarkers is used to determine the name of marker(s) for a from the imported ibd file. If no values are specified for ibdMarkers, then, by default, all imported ibd markers that exist in the myStrumData object are used, analyzing one by one. Therefore, the analysis result includes a list of strumFittedModel.

See Also

createStrumModel, createStrumData

Examples

# Run strum analysis.
# - myStrumModel is a strumModel object.
# - myStrumData is a strumData object.
#---------------------------------------
fitResult = strum(myStrumModel, myStrumData, ibdMarkers=c("marker1","marker2"))