register_cF {spaMM} | R Documentation |
Declare corrFamily constructor for use in formula
Description
register_cF
registers the name of a new corrFamily constructor so that it can be used as the keyword of a random effect in a formula (as in y ~ 1 + ARp()
). unregister_cF
cancels this.
Usage
register_cF(corrFamilies = NULL, reset = FALSE)
unregister_cF(corrFamilies)
Arguments
corrFamilies |
NULL, or character vector of names of corrFamily constructors. |
reset |
Boolean. Set it to |
Value
No value; operates through side-effects on internal variables.
Examples
ts <- data.frame(lh=lh,time=seq(48)) ## using 'lh' data from 'stats' package
myARp <- ARp # defines 'new' corrFamily from built-in one
# Now, this would not yet work:
# fitme(lh ~ 1 + myARp(1|time), data=ts, method="REML")
# but this works if we first register "myARp"
register_cF("myARp") # registers 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()))
#
# showing it's possible not to register myARp,
# although this has limitations (see Details in help("corrFamily")).
## 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)))
unregister_cF("myARp") # Tidy things before leaving.
[Package spaMM version 4.4.16 Index]