spaMM (version 2.4.35)

get_ranPars: More functions to extract various components of a fit

Description

get_ranPars returns various subsets of random-effect parameters.

Usage

get_ranPars(object, which=NULL, ...)

Arguments

object

A object of class HLfit, as returned by the fitting functions in spaMM.

which

For get_ranPars, the only non-null value is "corrPars", to return correlation parameters of random effects.

…

Other arguments that may be needed by some method.

Value

get_ranPars(.,which="corrPars") returns a (possibly nested) list of correlation parameters (or NULL if there is no such parameter). Top-level elements correspond to the different random effects. The list has "type" attribute having the same nested-list structure and describing whether and how the parameters where fitted: "fix" means they where fixed, not fitted; "var" means they were fitted by HLfit's specific algorithms; "outer" means they were fitted by a generic optimization method.

Examples

# NOT RUN {
data("wafers")
m1 <- HLfit(y ~X1+X2+(1|batch),
          resid.model = ~ 1 ,data=wafers,HLmethod="ML")
get_ranPars(m1,which="corrPars") # NULL since no correlated random effect          
# }