metafor (version 2.4-0)

ranef: Best Linear Unbiased Predictions for 'rma.uni' and 'rma.mv' Objects

Description

The function calculates best linear unbiased predictions (BLUPs) of the random effects for objects of class "rma.uni" and "rma.mv". Corresponding standard errors and prediction interval bounds are also provided.

Usage

# S3 method for rma.uni
ranef(object, level, digits, transf, targs, …)
# S3 method for rma.mv
ranef(object, level, digits, transf, targs, verbose=FALSE, …)

Arguments

object

an object of class "rma.uni" or "rma.mv".

level

numerical value between 0 and 100 specifying the prediction interval level (if unspecified, the default is to take the value from the object).

digits

integer specifying the number of decimal places to which the printed results should be rounded (if unspecified, the default is to take the value from the object).

transf

optional argument specifying the name of a function that should be used to transform the predicted values and interval bounds (e.g., transf=exp; see also transf). If unspecified, no transformation is used.

targs

optional arguments needed by the function specified under transf.

verbose

logical indicating whether output should be generated on the progress of the computations (the default is FALSE).

…

other arguments.

Value

For objects of class "rma.uni", an object of class "list.rma". The object is a list containing the following components:

pred

predicted values.

se

corresponding standard errors.

pi.lb

lower bound of the prediction intervals.

pi.ub

upper bound of the prediction intervals.

…

some additional elements/values.

The "list.rma" object is formatted and printed with print.list.rma.

For objects of class "rma.mv", a list of data frames with the same components as described above.

References

Kackar, R. N., & Harville, D. A. (1981). Unbiasedness of two-stage estimation and prediction procedures for mixed linear models. Communications in Statistics, Theory and Methods, 10, 1249--1261.

Raudenbush, S. W., & Bryk, A. S. (1985). Empirical Bayes meta-analysis. Journal of Educational Statistics, 10, 75--98.

Robinson, G. K. (1991). That BLUP is a good thing: The estimation of random effects. Statistical Science, 6, 15--32.

Searle, S. R., Casella, G., & McCulloch, C. E. (1992). Variance components. Hoboken, NJ: Wiley.

Viechtbauer, W. (2010). Conducting meta-analyses in R with the metafor package. Journal of Statistical Software, 36(3), 1--48. https://www.jstatsoft.org/v036/i03.

See Also

rma.uni, predict.rma, fitted.rma, blup.rma.uni

Examples

# NOT RUN {
### calculate log risk ratios and corresponding sampling variances
dat <- escalc(measure="RR", ai=tpos, bi=tneg, ci=cpos, di=cneg, data=dat.bcg)

### meta-analysis of the log risk ratios using a random-effects model
res <- rma(yi, vi, data=dat)

### BLUPs of the random effects
ranef(res)
# }

Run the code above in your browser using DataCamp Workspace