Predicted Values for 'rma' Objects
The function computes predicted values, corresponding standard errors, confidence intervals, and (approximate) credibility/prediction intervals for objects of class "rma"
.
## S3 method for class 'rma' predict(object, newmods, intercept, tau2.levels, gamma2.levels, addx=FALSE, level, digits, transf, targs, vcov=FALSE, ...)
object |
an object of class |
newmods |
optional vector or matrix specifying the values of the moderator values for which the predicted values should be calculated. See ‘Details’. |
intercept |
logical specifying whether the intercept should be included when calculating the predicted values for |
tau2.levels |
vector specifying the levels of the inner factor when computing credibility/prediction intervals. Only relevant for models of class |
gamma2.levels |
vector specifying the levels of the inner factor when computing credibility/prediction intervals. Only relevant for models of class |
addx |
logical specifying whether the values of the moderator variables should be added to the returned object. See ‘Examples’. |
level |
numerical value between 0 and 100 specifying the confidence and credibility/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., |
targs |
optional arguments needed by the function specified under |
vcov |
logical specifying whether the variance-covariance matrix of the predicted values should also be returned (the default is |
... |
other arguments. |
For a fixed-effects model, predict(object)
returns the estimated (average) outcome in the set of studies included in the meta-analysis. This is the same as the estimated intercept in the fixed-effects model.
For a random-effects model, predict(object)
returns the estimated (average) outcome in the hypothetical population of studies from which the set of studies included in the meta-analysis are assumed to be a random selection. This is the same as the estimated intercept in the random-effects model.
For models including one or more moderators, predict(object)
returns the estimated (average) outcomes for values of the moderator(s) equal to those of the k studies included in the meta-analysis (i.e., the fitted values for the k studies).
For models including q moderator variables, new moderator values for k_new new studies can be specified by setting newmods
equal to an k_new x q matrix with the corresponding new moderator values. If the original model includes an intercept, then it should not be explicitly specified under newmods
, as it will be added by default (unless one sets intercept=FALSE
). Also, any factors in the original model get turned into the appropriate contrast variables within the rma
function, so that newmods
should actually include the values for the contrast variables. Examples are shown below.
For random/mixed-effects models, an approximate credibility/credible or prediction interval is also calculated (Raudenbush, 2009; Riley et al., 2011). The interval estimates where level
% of the true outcomes fall in the hypothetical population of studies. Note that this interval is calculated under the assumption that the value of τ² is known (and not estimated). A method for calculating a credibility/prediction interval that accounts for the uncertainty in the estimate of τ² may be implemented in the future.
For random-effects models of class "rma.mv"
(see rma.mv
) with multiple τ² values (i.e., when the random
argument includes a ~ inner | outer
term and struct="HCS"
, struct="HAR"
, or struct="UN"
), the function will provide credibility/prediction intervals for each level of the inner factor (since the credibility/prediction intervals differ depending on the τ² value). Alternatively, one can use the tau2.levels
argument to specify for which level(s) the credibility/prediction interval should be provided.
If the model includes a second ~ inner | outer
term with multiple γ² values, credibility/prediction intervals for each combination of levels of the inner factors will be provided. Alternatively, one can use the tau2.levels
and gamma2.levels
arguments to specify for which level combination(s) the credibility/prediction interval should be provided.
When using the newmods
argument for mixed-effects models of class "rma.mv"
with multiple τ² (and multiple γ²) values, one must use the tau2.levels
(and gamma2.levels
) argument to specify the levels of the inner factor(s) (i.e., a vector of length k_new) to obtain the appropriate credibility/prediction interval(s).
An object of class "list.rma"
. The object is a list containing the following components:
pred |
predicted value(s). |
se |
corresponding standard error(s). |
ci.lb |
lower bound of the confidence interval(s). |
ci.ub |
upper bound of the confidence interval(s). |
cr.lb |
lower bound of the credibility/prediction interval(s) (only random/mixed-effects models). |
cr.ub |
upper bound of the credibility/prediction interval(s) (only random/mixed-effects models). |
tau2.level |
the level(s) of the inner factor (only for models of class |
gamma2.level |
the level(s) of the inner factor (only for models of class |
X |
the moderator value(s) used to calculate the predicted values (only when |
... |
some additional elements/values. |
If vcov=TRUE
, then the returned object is a list with the first element equal to the one as described above and the second element equal to the variance-covariance matrix of the predicted values.
The "list.rma"
object is formatted and printed with print.list.rma
.
The predicted values are based only on the fixed effects of the model. Best linear unbiased predictions (BLUPs) that combine the fitted values based on the fixed effects and the estimated contributions of the random effects can be obtained with blup.rma.uni
(currently only for objects of class "rma.uni"
).
When using the transf
option, the transformation is applied to the predicted values and the corresponding interval bounds. The standard errors are then set equal to NA
and are omitted from the printed output. Also, vcov=TRUE
is ignored when using the transf
option.
Confidence and credibility/prediction intervals are calculated based on the critical values from a standard normal distribution (i.e., +- 1.96 for level=95
). When the model was fitted with the Knapp and Hartung (2003) method (i.e., test="knha"
in the rma.uni
function) or with test="t"
in the rma.glmm
and rma.mv
functions, then the t-distribution with k-p degrees of freedom is used.
Wolfgang Viechtbauer wvb@metafor-project.org http://www.metafor-project.org/
Hedges, L. V., & Olkin, I. (1985). Statistical methods for meta-analysis. San Diego, CA: Academic Press.
Raudenbush, S. W. (2009). Analyzing effect sizes: Random effects models. In H. Cooper, L. V. Hedges, & J. C. Valentine (Eds.), The handbook of research synthesis and meta-analysis (2nd ed., pp. 295–315). New York: Russell Sage Foundation.
Riley, R. D., Higgins, J. P. T., & Deeks, J. J. (2011). Interpretation of random effects meta-analyses. British Medical Journal, 342, d549.
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.
### meta-analysis of the log risk ratios using a random-effects model res <- rma(measure="RR", ai=tpos, bi=tneg, ci=cpos, di=cneg, data=dat.bcg) ### average risk ratio with 95% CI predict(res, transf=exp) ### mixed-effects model with absolute latitude as a moderator res <- rma(measure="RR", ai=tpos, bi=tneg, ci=cpos, di=cneg, mods = ~ ablat, data=dat.bcg) ### predicted average risk ratios for given absolute latitude values predict(res, transf=exp, addx=TRUE) ### predicted average risk ratios for 10-60 degrees absolute latitude predict(res, newmods=c(10, 20, 30, 40, 50, 60), transf=exp) ### mixed-effects model with two moderators (absolute latitude and publication year) res <- rma(measure="RR", ai=tpos, bi=tneg, ci=cpos, di=cneg, mods = ~ ablat + year, data=dat.bcg) ### predicted average risk ratios for 10 and 60 degrees latitude in 1950 and 1980 predict(res, newmods=cbind(c(10,60,10,60),c(1950,1950,1980,1980)), transf=exp, addx=TRUE) ### mixed-effects model with two moderators (one of which is a factor) res <- rma(measure="RR", ai=tpos, bi=tneg, ci=cpos, di=cneg, mods = ~ ablat + factor(alloc), data=dat.bcg) ### examine how the factor was actually coded for the studies in the dataset predict(res, addx=TRUE) ### predictd average risk ratios at 30 degrees for the three factor levels ### note: the contrast (dummy) variables need to specified explicitly here predict(res, newmods=c(30, 0, 0), addx=TRUE) # for alternate allocation predict(res, newmods=c(30, 1, 0), addx=TRUE) # for random allocation predict(res, newmods=c(30, 0, 1), addx=TRUE) # for systematic allocation ### can also use named vector with arbitrary order and abbreviated variable names predict(res, newmods=c(sys=0, ran=0, abl=30)) predict(res, newmods=c(sys=0, ran=1, abl=30)) predict(res, newmods=c(sys=1, ran=0, abl=30))
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.