sommer (version 4.1.2)

predict.mmer: Predict form of a LMM fitted with mmer

Description

predict method for class "mmer".

Usage

# S3 method for mmer
predict(object, classify=NULL, 
        hypertable=NULL,
        …)

Arguments

object

a mixed model of class "mmer"

classify

a character vector with the variables that define the margins of the multiway table to be aggregated.

hypertable

an optional table to force the terms to be included and ignored with same format as the output hypertable of this function (see examples).

…

Further arguments to be passed to the model fit (i.e. iters, etc.).

Value

pvals

the table of predictions according to the specified arguments.

hypertable

the summary table specifying the ignored and include sets.

model

the mixed model used within predict.

C11

the inverse of the coefficient matrix corresponding to the fixed effects.

C12

the inverse of the coefficient matrix corresponding to the covariance between fixed and random effects.

C22

the inverse of the coefficient matrix corresponding to the random effects.

Details

This function allows to produce predictions specifying those variables that define the margins of the hypertable to be predicted (argument classify). Predictions are obtained for each combination of values of the specified variables that is present in the data set used to fit the model. See vignettes for more details.

For predicted values the pertinent design matrices X and Z together with BLUEs (b) and BLUPs (u) are multiplied and added together.

predicted.value equal Xb + Zu.1 + ... + Zu.n

For computing standard errors for predictions the parts of the coefficient matrix:

C11 equal (X'ViX)-

C12 equal 0 - [(X'V-X)-X' V- GZ]

C22 equal PEV equal G - [Z'G[V- - (VX*tXVXVX)]GZ']

and are summarized as:

standard.errors equal sqrt( rowSums(XC11*X') + rowSums(2*(XC12*Z')) + rowSums(ZC22*Z') )

when both fixed and random effects are present in the inclusion set. If only fixed and random effects are included, only the respective terms from the SE for fixed or random effects are calculated.

References

Welham, S., Cullis, B., Gogel, B., Gilmour, A., and Thompson, R. (2004). Prediction in linear mixed models. Australian and New Zealand Journal of Statistics, 46, 325 - 347.

See Also

predict, mmer

Examples

# NOT RUN {
data(DT_yatesoats)
DT <- DT_yatesoats

m3 <- mmer(fixed=Y ~ V + N + V:N,
           random = ~ B + B:MP,
           rcov=~units,
           data = DT)
summary(m3)$varcomp

p0 <- predict.mmer(object=m3, classify = "N")
p0$hypertable; p0$pvals

p0 <- predict.mmer(object=m3, classify = "V")
p0$hypertable; p0$pvals

p0 <- predict.mmer(object=m3, classify = "B")
p0$hypertable; p0$pvals

p0 <- predict.mmer(object=m3, classify = c("V","N"))
p0$hypertable; p0$pvals

########################################
## force the inclusion of specific terms
## in the hypertable
########################################
p0 <- predict.mmer(object=m3, classify = "N")
hypertable <- p0$hypertable; hypertable
p0$pvals
# force inclusion of 5th term
hypertable[6,c("ignored","include")] <- c(FALSE,TRUE) 
hypertable

p1 <- predict.mmer(object=m3, classify = "N", hypertable = hypertable)
p1$hypertable;p1$pvals

########################################
## force the exclusion of specific terms
## in the hypertable
########################################
p0 <- predict.mmer(object=m3, classify = "N")
hypertable <- p0$hypertable; hypertable
p0$pvals
# force inclusion of 4th term
hypertable[4,c("ignored","include")] <- c(TRUE,FALSE) 
hypertable

p1 <- predict.mmer(object=m3, classify = "N", hypertable = hypertable)
p1$hypertable;p1$pvals

# }