spaMM (version 3.11.3)

register_cF: Declare corrFamily constructor for use in formula

Description

This function registers the name of a corrFamily constructor (say, "ARp", but a user-defined constructor could be registered in the same way) so that it can be used as the keyword of a random effect in a formula (as in y ~ 1 + ARp())

This feature is experimental.

Usage

register_cF(corrFamilies = NULL, reset = FALSE)

Arguments

corrFamilies

NULL, or character vector of names of corrFamily constructors.

reset

Boolean. Set it to TRUE in order to reset the list of registered constructors to the spaMM built-in default, before registering the ones specified by corrFamilies.

Value

No value; operates through side-effects on internal variables.

Examples

# NOT RUN {
ts <- data.frame(lh=lh,time=seq(48)) ## using 'lh' data from 'stats' package

myARp <- ARp                   #  defines 'new' corrFamily from built-in one 
register_cF("myARp")           #  register it

fitme(lh ~ 1 + myARp(1|time), data=ts, method="REML")
#
# same as
#
fitme(lh ~ 1 + corrFamily(1|time), data=ts, method="REML",
                  covStruct=list(corrFamily=myARp()))

## Specifying arguments of the corrFamily constructor:

fitme(lh ~ 1 + myARp(1|time, p=3), data=ts, method="REML")
#                  
# same as
#
fitme(lh ~ 1 + corrFamily(1|time), data=ts, method="REML",
                  covStruct=list(corrFamily=ARp(p=3)))
                  
register_cF(reset=TRUE) # Tidy things before leaving.                  
                  
# }