Functions to compute confidence intervals for the model coefficients, variance components, and other parameters in meta-analytic models.
# S3 method for rma.uni
confint(object, parm, level, fixed=FALSE, random=TRUE, type,
digits, transf, targs, verbose=FALSE, control, ...)# S3 method for rma.mh
confint(object, parm, level, digits, transf, targs, ...)
# S3 method for rma.peto
confint(object, parm, level, digits, transf, targs, ...)
# S3 method for rma.glmm
confint(object, parm, level, digits, transf, targs, ...)
# S3 method for rma.mv
confint(object, parm, level, fixed=FALSE, sigma2, tau2, rho, gamma2, phi,
digits, transf, targs, verbose=FALSE, control, ...)
# S3 method for rma.uni.selmodel
confint(object, parm, level, fixed=FALSE, tau2, delta,
digits, transf, targs, verbose=FALSE, control, ...)
# S3 method for rma.ls
confint(object, parm, level, fixed=FALSE, alpha,
digits, transf, targs, verbose=FALSE, control, ...)
An object of class "confint.rma". The object is a list with either one or two elements (named fixed and random) with the following elements:
estimate of the model coefficient, variance/correlation component, or selection model parameter.
lower bound of the confidence interval.
upper bound of the confidence interval.
When obtaining confidence intervals for multiple components, the object is a list of class "list.confint.rma", where each element is a "confint.rma" object as described above.
The results are formatted and printed with the print function. To format the results as a data frame, one can use the as.data.frame function.
an object of class "rma.uni", "rma.mh", "rma.peto", "rma.mv", "rma.uni.selmodel", or "rma.ls". The method is not yet implemented for objects of class "rma.glmm".
this argument is here for compatibility with the generic function confint, but is (currently) ignored.
logical to specify whether confidence intervals for the model coefficients should be returned.
logical to specify whether a confidence interval for the amount of (residual) heterogeneity should be returned.
optional character string to specify the method for computing the confidence interval for the amount of (residual) heterogeneity (either "QP", "GENQ", "PL", or "HT").
integer to specify for which ^2 parameter a confidence interval should be obtained.
integer to specify for which ^2 parameter a confidence interval should be obtained.
integer to specify for which parameter the confidence interval should be obtained.
integer to specify for which ^2 parameter a confidence interval should be obtained.
integer to specify for which parameter a confidence interval should be obtained.
integer to specify for which parameter a confidence interval should be obtained.
integer to specify for which parameter a confidence interval should be obtained.
numeric value between 0 and 100 to specify the confidence interval level (see here for details). If unspecified, the default is to take the value from the object.
optional integer to specify the number of decimal places to which the results should be rounded. If unspecified, the default is to take the value from the object.
optional argument to specify a function to transform the model coefficients and interval bounds (e.g., transf=exp; see also transf). If unspecified, no transformation is used.
optional arguments needed by the function specified under transf.
logical to specify whether output should be generated on the progress of the iterative algorithms used to obtain the confidence intervals (the default is FALSE). See ‘Details’.
list of control values for the iterative algorithms. If unspecified, default values are used. See ‘Note’.
other arguments.
Wolfgang Viechtbauer wvb@metafor-project.org https://www.metafor-project.org
Confidence intervals for the model coefficients can be obtained by setting fixed=TRUE and are simply the usual Wald-type intervals (which are also shown when printing the fitted object).
Other parameter(s) for which confidence intervals can be obtained depend on the model object:
For objects of class "rma.uni" obtained with the rma.uni function, a confidence interval for the amount of (residual) heterogeneity (i.e., ^2) can be obtained by setting random=TRUE (which is the default). The interval is obtained iteratively either via the Q-profile method or via the generalized Q-statistic method (Hartung and Knapp, 2005; Viechtbauer, 2007; Jackson, 2013; Jackson et al., 2014). The latter is automatically used when the model was fitted with method="GENQ" or method="GENQM", the former is used in all other cases. Either method provides an exact confidence interval for ^2 in random- and mixed-effects models. The square root of the interval bounds is also returned for easier interpretation. Confidence intervals for I^2 and H^2 are also provided (Higgins & Thompson, 2002). Since I^2 and H^2 are just monotonic transformations of ^2 (for details, see print), the confidence intervals for I^2 and H^2 are also exact. One can also set type="PL" to obtain a profile likelihood confidence interval for ^2 (and corresponding CIs for I^2 and H^2), which would be more consistent with the use of ML/REML estimation, but is not exact (see ‘Note’). For models without moderators (i.e., random-effects models), one can also set type="HT", in which case the ‘test-based method’ (method III in Higgins & Thompson, 2002) is used to construct confidence intervals for ^2, I^2, and H^2 (see also Borenstein et al., 2009, chapter 16). However, note that this method tends to yield confidence intervals that are too narrow when the amount of heterogeneity is large.
For objects of class "rma.mv" obtained with the rma.mv function, confidence intervals are obtained by default for all variance and correlation components of the model. Alternatively, one can use the sigma2, tau2, rho, gamma2, or phi arguments to specify for which variance/correlation parameter a confidence interval should be obtained. Only one of these arguments can be used at a time. A single integer is used to specify the number of the parameter. The function provides profile likelihood confidence intervals for these parameters. It is a good idea to examine the corresponding profile likelihood plots (via the profile function) to make sure that the bounds obtained are sensible.
For selection model objects of class "rma.uni.selmodel" obtained with the selmodel function, confidence intervals are obtained by default for ^2 (for models where this is an estimated parameter) and all selection model parameters. Alternatively, one can choose to obtain a confidence interval only for ^2 by setting tau2=TRUE or for one of the selection model parameters by specifying its number via the delta argument. The function provides profile likelihood confidence intervals for these parameters. It is a good idea to examine the corresponding profile likelihood plots (via the profile function) to make sure that the bounds obtained are sensible.
For location-scale model objects of class "rma.ls" obtained with the rma.uni function, confidence intervals are obtained by default for all scale parameters. Alternatively, one can choose to obtain a confidence interval for one of the scale parameters by specifying its number via the alpha argument. The function provides profile likelihood confidence intervals for these parameters. It is a good idea to examine the corresponding profile likelihood plots (via the profile function) to make sure that the bounds obtained are sensible.
The methods used to find confidence intervals for these parameters are iterative and require the use of the uniroot function. By default, the desired accuracy (tol) is set equal to .Machine$double.eps^0.25 and the maximum number of iterations (maxiter) to 1000. These values can be adjusted with control=list(tol=value, maxiter=value), but the defaults should be adequate for most purposes. If verbose=TRUE, output is generated on the progress of the iterative algorithms. This is especially useful when model fitting is slow, in which case finding the confidence interval bounds can also take considerable amounts of time.
When using the uniroot function, one must also set appropriate end points of the interval to be searched for the confidence interval bounds. The function sets some sensible defaults for the end points, but it may happen that the function is only able to determine that a bound is below/above a certain limit (this is indicated in the output accordingly with < or > signs). It can also happen that the model cannot be fitted or does not converge especially at the extremes of the interval to be searched. This will result in missing (NA) bounds and corresponding warnings. It may then be necessary to adjust the end points manually (see ‘Note’).
Finally, it is also possible that the lower and upper confidence interval bounds for a variance component both fall below zero. Since both bounds then fall outside of the parameter space, the confidence interval then consists of the null/empty set. Alternatively, one could interpret this as a confidence interval with bounds [0,0] or as indicating ‘highly/overly homogeneous’ data.
Borenstein, M., Hedges, L. V., Higgins, J. P. T., & Rothstein, H. (2009). Introduction to meta-analysis. Chichester, UK: Wiley.
Hardy, R. J., & Thompson, S. G. (1996). A likelihood approach to meta-analysis with random effects. Statistics in Medicine, 15(6), 619--629. https://doi.org/10.1002/(sici)1097-0258(19960330)15:6%3C619::aid-sim188%3E3.0.co;2-a
Hartung, J., & Knapp, G. (2005). On confidence intervals for the among-group variance in the one-way random effects model with unequal error variances. Journal of Statistical Planning and Inference, 127(1-2), 157--177. https://doi.org/10.1016/j.jspi.2003.09.032
Higgins, J. P. T., & Thompson, S. G. (2002). Quantifying heterogeneity in a meta-analysis. Statistics in Medicine, 21(11), 1539--1558. https://doi.org/10.1002/sim.1186
Jackson, D. (2013). Confidence intervals for the between-study variance in random effects meta-analysis using generalised Cochran heterogeneity statistics. Research Synthesis Methods, 4(3), 220--229. https://doi.org/10.1186/s12874-016-0219-y
Jackson, D., Turner, R., Rhodes, K., & Viechtbauer, W. (2014). Methods for calculating confidence and credible intervals for the residual between-study variance in random effects meta-regression models. BMC Medical Research Methodology, 14, 103. https://doi.org/10.1186/1471-2288-14-103
Viechtbauer, W. (2007). Confidence intervals for the amount of heterogeneity in meta-analysis. Statistics in Medicine, 26(1), 37--52. https://doi.org/10.1002/sim.2514
Viechtbauer, W. (2010). Conducting meta-analyses in R with the metafor package. Journal of Statistical Software, 36(3), 1--48. https://doi.org/10.18637/jss.v036.i03
Viechtbauer, W., & López-López, J. A. (2022). Location-scale models for meta-analysis. Research Synthesis Methods. 13(6), 697--715. https://doi.org/10.1002/jrsm.1562
rma.uni, rma.mh, rma.peto, rma.glmm, rma.mv, and selmodel for functions to fit models for which confidence intervals can be computed.
profile for functions to create profile likelihood plots corresponding to profile likelihood confidence intervals.
### 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, method="REML")
### confidence interval for the total amount of heterogeneity
confint(res)
### mixed-effects model with absolute latitude in the model
res <- rma(yi, vi, mods = ~ ablat, data=dat)
### confidence interval for the residual amount of heterogeneity
confint(res)
### multilevel random-effects model
res <- rma.mv(yi, vi, random = ~ 1 | district/school, data=dat.konstantopoulos2011)
### profile plots and confidence intervals for the variance components
if (FALSE) {
par(mfrow=c(2,1))
profile(res, sigma2=1, steps=40, cline=TRUE)
sav <- confint(res, sigma2=1)
sav
abline(v=sav$random[1,2:3], lty="dotted")
profile(res, sigma2=2, steps=40, cline=TRUE)
sav <- confint(res, sigma2=2)
sav
abline(v=sav$random[1,2:3], lty="dotted")
}
### multivariate parameterization of the model
res <- rma.mv(yi, vi, random = ~ school | district, data=dat.konstantopoulos2011)
### profile plots and confidence intervals for the variance component and correlation
if (FALSE) {
par(mfrow=c(2,1))
profile(res, tau2=1, steps=40, cline=TRUE)
sav <- confint(res, tau2=1)
sav
abline(v=sav$random[1,2:3], lty="dotted")
profile(res, rho=1, steps=40, cline=TRUE)
sav <- confint(res, rho=1)
sav
abline(v=sav$random[1,2:3], lty="dotted")
}
Run the code above in your browser using DataLab