| 1 |
% Generated by roxygen2: do not edit by hand |
| 2 |
% Please edit documentation in R/rma-mv.R |
| 3 |
\name{vcovCR.rma.mv} |
| 4 |
\alias{vcovCR.rma.mv} |
| 5 |
\title{Cluster-robust variance-covariance matrix for a rma.mv object.} |
| 6 |
\usage{ |
| 7 |
\method{vcovCR}{rma.mv}(obj, cluster, type, target, inverse_var, form = "sandwich", ...) |
| 8 |
} |
| 9 |
\arguments{ |
| 10 |
\item{obj}{Fitted model for which to calculate the variance-covariance matrix} |
| 11 |
|
| 12 |
\item{cluster}{Optional expression or vector indicating which observations |
| 13 |
belong to the same cluster. If not specified, will be set to the factor in |
| 14 |
the random-effects structure with the fewest distinct levels. Caveat |
| 15 |
emptor: the function does not check that the random effects are nested.} |
| 16 |
|
| 17 |
\item{type}{Character string specifying which small-sample adjustment should |
| 18 |
be used, with available options \code{"CR0"}, \code{"CR1"}, \code{"CR1p"}, |
| 19 |
\code{"CR1S"}, \code{"CR2"}, or \code{"CR3"}. See "Details" section of |
| 20 |
\code{\link{vcovCR}} for further information.} |
| 21 |
|
| 22 |
\item{target}{Optional matrix or vector describing the working |
| 23 |
variance-covariance model used to calculate the \code{CR2} and \code{CR4} |
| 24 |
adjustment matrices. If not specified, the target is taken to be the |
| 25 |
estimated variance-covariance structure of the \code{rma.mv} object.} |
| 26 |
|
| 27 |
\item{inverse_var}{Optional logical indicating whether the weights used in |
| 28 |
fitting the model are inverse-variance. If not specified, \code{vcovCR} |
| 29 |
will attempt to infer a value.} |
| 30 |
|
| 31 |
\item{form}{Controls the form of the returned matrix. The default |
| 32 |
\code{"sandwich"} will return the sandwich variance-covariance matrix. |
| 33 |
Alternately, setting \code{form = "meat"} will return only the meat of the |
| 34 |
sandwich and setting \code{form = B}, where \code{B} is a matrix of |
| 35 |
appropriate dimension, will return the sandwich variance-covariance matrix |
| 36 |
calculated using \code{B} as the bread. \code{form = "estfun"} will return the |
| 37 |
(appropriately scaled) estimating function, the transposed crossproduct of |
| 38 |
which is equal to the sandwich variance-covariance matrix.} |
| 39 |
|
| 40 |
\item{...}{Additional arguments available for some classes of objects.} |
| 41 |
} |
| 42 |
\value{ |
| 43 |
An object of class \code{c("vcovCR","clubSandwich")}, which consists |
| 44 |
of a matrix of the estimated variance of and covariances between the |
| 45 |
regression coefficient estimates. |
| 46 |
} |
| 47 |
\description{ |
| 48 |
\code{vcovCR} returns a sandwich estimate of the variance-covariance matrix |
| 49 |
of a set of regression coefficient estimates from a |
| 50 |
\code{\link[metafor]{rma.mv}} object. |
| 51 |
} |
| 52 |
\examples{ |
| 53 |
|
| 54 |
pkgs_available <- |
| 55 |
requireNamespace("metafor", quietly = TRUE) & |
| 56 |
requireNamespace("metadat", quietly = TRUE) |
| 57 |
|
| 58 |
if (pkgs_available) withAutoprint({ |
| 59 |
|
| 60 |
library(metafor) |
| 61 |
data(dat.assink2016, package = "metadat") |
| 62 |
|
| 63 |
mfor_fit <- rma.mv(yi ~ year + deltype, |
| 64 |
V = vi, random = ~ 1 | study / esid, |
| 65 |
data = dat.assink2016) |
| 66 |
mfor_fit |
| 67 |
|
| 68 |
mfor_CR2 <- vcovCR(mfor_fit, type = "CR2") |
| 69 |
mfor_CR2 |
| 70 |
|
| 71 |
coef_test(mfor_fit, vcov = mfor_CR2, test = c("Satterthwaite", "saddlepoint")) |
| 72 |
Wald_test(mfor_fit, constraints = constrain_zero(3:4), vcov = mfor_CR2) |
| 73 |
|
| 74 |
}) |
| 75 |
|
| 76 |
} |
| 77 |
\seealso{ |
| 78 |
\code{\link{vcovCR}} |
| 79 |
} |