print.dmm: Print method for a 'dmm()' fitted model object.
In dmm: Dyadic Mixed Model for Pedigree Data

print.dmm

R Documentation

Print method for a `dmm()` fitted model object.

Description

Provide a short description of the model fitted and the fixed effects and (co)variance component estimates obtained for an object of class dmm.

Usage

## S3 method for class 'dmm'
print(x, traitset = "all", gls = F, ...)

Arguments

`x`	An object of class `dmm`.
`traitset`	A vector containing the names of the subset of traits for which fixed effects and (co)variance components are to be printed. Default is "all" which means to print estimates for all traits present in object `x`.
`gls`	Logical flag: should the fixed effects and (co)variance component estimates by GLS-b method be printed in addition to the fixed effects and (co)variance component estimates by OLS-b method? Default is `gls=FALSE`. The GLS-b fixed effects and (co)variance component estimates can only be printed if object `x` contains the attribute `gls`, that is if `x` was constructed by a `dmm()` call with argument `gls=TRUE`.
`...`	Ellipsis argument.

Details

This is a short printout without standard errors or confidence limits. For a more extensive printout with standard errors and confidence limits, see function summary.dmm(). The printout includes fixed effects, variance component estimates, and correlations among columns of the W matrix of the dyadic model equations.

Value

There is no return value. Function is used for its side effects.

Note

For a similar short printout, but with genetic parameters instead on (co)variance components, see function gprint.dmm().

Author(s)

Neville Jackson

Examples


library(dmm)
data(sheep.df)
sheep.mdf <- mdf(sheep.df,pedcols=c(1:3),factorcols=c(4:6),ycols=c(7:9),
             sexcode=c("M","F"),relmat=c("E","A","D"))
# make a simple fit object - OLS-b only
sheep.fit1 <- dmm(sheep.mdf, Ymat ~ 1 + Year + Sex,
    components=c("VarE(I)","VarG(Ia)"))
# look at model plus fixed effects and components for all traits
print(sheep.fit1)
## Not run: 
# can do the same thing without saving fit object
dmm(sheep.mdf, Ymat ~ 1 + Year + Tb + Sex,
    components=c("VarE(I)","VarG(Ia)"))
# so this is the default print method for an object of class 'dmm'

## End(Not run)
#cleanup
rm(sheep.fit1)
rm(sheep.mdf)
rm(sheep.df)

dmm documentation built on July 26, 2023, 5:23 p.m.