Extract Random Effects

Generic function for extracting the random effects. This is the same generic (and same name) defined in the nlme and lme4 package.

ranef(object, ...)

random.effects(object, ...)

# S3 method for default
random.effects(object, ...)

# S3 method for default
ranef(object, ...)

# S3 method for ggmix_gic
ranef(object, s = "lambda.min", ...)

Arguments

object	any fitted model object from which random effects estimates can be extracted. Currently supports "ggmix_gic" objects outputted by the gic function
...	other parameters. currently ignored
s	Value(s) of the penalty parameter lambda at which predictions are required. Default is the value s="lambda.min" can be used. If s is numeric, it is taken as the value(s) of lambda to be used.

Value

a numeric vector of length equal to the number of observations of subject-specific random effects

Details

For objects of class "ggmix_gic", this function returns the subject-specific random effect value for the model which minimizes the GIC using the maximum a posteriori principle

See also

gic

Examples

data("admixed")
fit <- ggmix(x = admixed$xtrain, y = admixed$ytrain,
            kinship = admixed$kin_train)
gicfit <- gic(fit)
# random effect at selected value of lambda
plot(ggmix::ranef(gicfit))
# random effects at specific values of lambda
head(ggmix::ranef(gicfit, s = c(0.1,0.2)))
#>                1          2
#> [1,] -2.50068689 -3.3319049
#> [2,]  1.18958290  1.6479184
#> [3,] -0.56591630 -0.7010323
#> [4,] -0.93637814 -1.3405188
#> [5,] -0.35160641 -0.7833144
#> [6,]  0.05101435 -0.2833299