Debian Codegraph @

man/vcovCR.robu.Rd

raw
1 % Generated by roxygen2: do not edit by hand
2 % Please edit documentation in R/robu.R
3 \name{vcovCR.robu}
4 \alias{vcovCR.robu}
5 \title{Cluster-robust variance-covariance matrix for a robu object.}
6 \usage{
7 \method{vcovCR}{robu}(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
14 \code{studynum} used in fitting the \code{\link[robumeta]{robu}} object.}
15
16 \item{type}{Character string specifying which small-sample adjustment should
17 be used, with available options \code{"CR0"}, \code{"CR1"}, \code{"CR1p"},
18 \code{"CR1S"}, \code{"CR2"}, or \code{"CR3"}. See "Details" section of
19 \code{\link{vcovCR}} for further information.}
20
21 \item{target}{Optional matrix or vector describing the working
22 variance-covariance model used to calculate the \code{CR2} and \code{CR4}
23 adjustment matrices. If not specified, the target is taken to be the
24 inverse of the estimated weights used in fitting the
25 \code{\link[robumeta]{robu}} 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[robumeta]{robu}} object.
51 }
52 \examples{
53
54 if (requireNamespace("robumeta", quietly = TRUE)) withAutoprint({
55 library(robumeta)
56 data(hierdat)
57
58 robu_fit <- robu(effectsize ~ binge + followup + sreport + age,
59 data = hierdat, studynum = studyid,
60 var.eff.size = var, modelweights = "HIER")
61 robu_fit
62
63 robu_CR2 <- vcovCR(robu_fit, type = "CR2")
64 robu_CR2
65 coef_test(robu_fit, vcov = robu_CR2, test = c("Satterthwaite", "saddlepoint"))
66
67 Wald_test(robu_fit, constraints = constrain_zero(c(2,4)), vcov = robu_CR2)
68 Wald_test(robu_fit, constraints = constrain_zero(2:5), vcov = robu_CR2)
69
70 })
71
72 }
73 \seealso{
74 \code{\link{vcovCR}}
75 }