Debian Codegraph @

NEWS.md

raw
1 # clubSandwich 0.7.0
2
3 * Added support for `mmrm::mmrm()` models.
4 * Added support for `estimatr::iv_robust()` models.
5 * Fixed bug in internal function `get_data()` introduced by changes in error message structure in R-devel.
6
7 # clubSandwich 0.6.2
8
9 * Fixed bug in internal function `get_cor_grouping()`, which identifies the grouping variable in `nlme::lme()` models with correlation structures.
10 * Fixed bug in `bread.rma.mv()` occurring in models with `test = 'knha'` (an undocumented, experimental option).
11 * Fixed bug in `linear_contrast()` occurring for certain linear contrasts in models with weights that are not inverse variance.
12
13 # clubSandwich 0.6.1
14
15 * Added support for `estimatr::lm_robust()` and `estimatr::lm_lin()` models.
16
17 # clubSandwich 0.6.0
18
19 * Added option to Wald_test() and linear_contrast() to correct hypothesis tests for multiple comparisons.
20 * Added option to coef_test() to specify one- or two-sided alternative hypotheses.
21 * Added options to Wald_test() and coef_test() to specify non-zero values for null hypotheses.
22 * Fixed a bug in methods for `geepack::geeglm()` models that occurred for models with nonlinear link functions.
23 * Corrected typo in deprecation messages for `impute_covariance_matrix()` and `pattern_covariance_matrix()`.
24
25 # clubSandwich 0.5.11
26
27 * Corrected a unit test related to the plm package, for compatibility with upcoming release of plm.
28 * Deprecated `impute_covariance_matrix()` and `pattern_covariance_matrix()`, because they have been superseded by `metafor::vcalc()`.
29
30 # clubSandwich 0.5.10
31
32 * Fixed another bug in `linear_contrast()` to handle specified contrasts that are scalars when variance-covariance matrix is computed with a working model that is not inverse-variance.
33 * Fixed formatting of package version numbers in unit tests to conform to changes in `packageVersion()` in R-devel.
34
35 # clubSandwich 0.5.9
36
37 * Added support for `geepack::geeglm()` models.
38 * Added support for `rma.ls` models (location-scale models estimated using `metafor::rma.uni(scale = )`).
39 * Improved error handling of `Wald_test()` when vcov of contrasts is not positive definite.
40 * Fixed a bug in `linear_contrast()` to handle specified contrasts that are scalars.
41 * Improved internal `get_data` function for `gls` and `lme` objects to allow use of expressions in addition to object names.
42
43 # clubSandwich 0.5.8
44
45 * Added support for `ivreg::ivreg` objects when estimated by ordinary least squares (support for objects estimated by 2SM and 2SMM is not yet implemented).
46 * Updated unit tests for `plm::plm()` when `method = "FD"` to account for bug fixes in version 2.6-2 of plm.
47
48 # clubSandwich 0.5.7
49
50 * Fixed bug in methods for multi-variate multi-level models estimated with lme().
51 * Updated vignettes, examples, and unit tests so that the package can be compiled without any packages from SUGGESTS.
52
53 # clubSandwich 0.5.6
54
55 * Corrected bug in methods for `plm` objects estimated by random effects, which occurred when a user-specified clustering variable was at a higher level than the random effects.
56 * Added support for `plm` objects with nested random effects (`effects = "nested"`).
57 * Added additional syntactic options for specifying clustering variable with `plm` objects. See `?plm`.
58 * Corrected bug in how `Wald_test()` labeled results when `test = "Naive-Fp"`.
59
60 # clubSandwich 0.5.5
61
62 * New function `linear_contrast()` calculates robust confidence intervals and p-values for linear contrasts of regression coefficients from a fitted model. Works with `constrain_pairwise()` and other `constrain_*()` helper functions.
63
64 * Corrected precision of unit test leading to error on M1mac.
65
66 # clubSandwich 0.5.4
67
68 ## New features
69
70 * `Wald_test()` gains an option for `test = "Naive-Fp"`, which uses denominator degrees of freedom equal to the number of clusters minus the number of coefficients in the fitted model.
71 * `coef_test()` and `conf_int()` gain an option for `test = "naive-tp"`, which uses denominator degrees of freedom equal to the number of clusters minus the number of coefficients in the fitted model.
72
73 ## Minor improvements and bug fixes
74
75 * Corrected a bug in the Satterthwaite degrees of freedom calculations for models that include only an intercept.
76
77 * Output of `coef_test()` and `conf_int()` now include a variable containing the coefficient names, so that the results are "tidy."
78
79 * `conf_int()` now includes an option to report a p-value for each coefficient.
80
81 * `coef_test()` now reports degrees of freedom for `test = 'z'` and `test = 'naive-t'`.
82
83 * `vcovCR()` now provides a more informative error message when the clustering variable is a constant.
84
85 * `vcovCR()` now handles models estimated using analytic weights, where some weights are equal to zero. Results are consistent with omitting observations with weights of zero.
86
87 * Added more informative error messages for `Wald_test()` and `conf_int()`, triggered if the test argument does not match any of the available tests.
88
89 * Corrected a bug in `findCluster.rma.mv()`, which threw an error if a random effects factor in the rma.mv model had unobserved levels.
90
91 * Corrected a bug in `Wald_test()`, which threw an error for tests of intercept-only models.
92
93 * Fixed a minor bug in print method for `Wald_test()` results, which threw an error when the p-value was `NA`.
94
95 # clubSandwich 0.5.3
96
97 * Removed dependency on mathjaxr
98
99 # clubSandwich 0.5.2
100
101 * Added mathjaxr to Imports
102
103 # clubSandwich 0.5.1
104
105 ## New features
106
107 * New functionality for `impute_covariance_matrix()`:
108 * Compute covariance matrices with AR1 correlation structure or with a combination of constant correlation and AR1 correlation structure.
109 * Compute covariance matrices that are blocked by subgroup.
110 * Average the variance estimates by cluster before computing covariance matrices.
111
112 * New function `pattern_covariance_matrix()`, which creates a covariance matrix based on a specified pattern of correlations between different categories of effects.
113
114 ## Minor improvements and bug fixes
115
116 * Corrected bug in methods for `rma.mv` objects, which previously led to incorrect identification of clustering variables in models with multiple levels of random effects, where at least one set of random effects has inner | outer structure.
117
118
119 # clubSandwich 0.5.0
120
121 ## New features: a major update to `Wald_test()`
122
123 * `Wald_test()` now uses new helper functions `constrain_zero()`, `constrain_equal()`, and `constrain_pairwise()` to specify constraint matrices.
124
125 * `Wald_test()` gains an argument `tidy`. When `TRUE`, results for a list of tests will be tidied into a single data.frame.
126
127 * Output of `Wald_test()` now includes both numerator and denominator degrees of freedom.
128
129 ## Minor improvements and bug fixes
130
131 * Corrected bug in methods for `plm` objects, which occurred when "within" models included cluster-level interactions. Previously main effects of cluster-level variables were not getting dropped from `model_matrix.plm()`.
132
133 * Corrected bugs in methods for `robu` objects
134 * Corrected a bug that previously led to errors for models with only one column in the model matrix (i.e., intercept-only models).
135 * Corrected a bug in an internal function that previously led to errors in `constrain_equal()` and `constrain_zero()` when called on robu objects.
136
137
138 # clubSandwich 0.4.2
139
140 * Updated and streamlined unit tests for R 4.0.0.
141
142 # clubSandwich 0.4.1
143
144 * Updated unit tests to satisfy obscure CRAN checks.
145
146 # clubSandwich 0.4.0
147
148 * Added methods for `lmerMod` objects fitted by `lme4::lmer()`.
149
150 * Updated internals to use `inherits()` instead of checking `class()` directly.
151
152 # clubSandwich 0.3.5
153
154 * Added t statistics to output of `coef_test()`.
155
156 * Fixed a bug in `get_index_order()`, an internal function used with plm objects. Previously, the function assumed that both individual and time indices were specified in the `plm` call. The new function works even when zero or one indices are specified.
157
158 # clubSandwich 0.3.3
159
160 * `impute_covariance_matrix()` now drops unobserved factor levels.
161
162 * updated method for handling residuals from `rma.uni` and `rma.mv` objects, for consistency with metafor 2.1-0.
163
164 # clubSandwich 0.3.2
165
166 * Added `conf_int()` to provide easy cluster-robust confidence intervals.
167
168 * Added examples to documentation for `conf_int()` and `coef_test()`.
169
170 # clubSandwich 0.3.1
171
172 * Added `coefs` option to `coef_test()` to allow testing of subsets of coefficients.
173
174 * Updated tests to use `carData` instead of car package.
175
176 # clubSandwich 0.3.0
177
178 * Added methods for `ivreg` objects.
179
180 * Added methods for `mlm` objects.
181
182 * Updated `residuals_CS.plm` to account for changes in plm 1.6-6.
183
184 # clubSandwich 0.2.3
185
186 ## New features
187
188 * Added methods for `glm` objects.
189
190 * Provide facility to cluster at higher level than highest random effects for `lme` and `gls` objects.
191
192 * Added `impute_covariance_matrix()` utility function for multivariate meta-analysis.
193
194 ## Minor improvements and bug fixes
195
196 * Updated methods for plm objects to account for changes in plm 1.6-6.
197
198 * Added documentation of `type` options in `vcovCR()`.
199
200 * Added examples for all `vcovCR()` methods.
201
202 # clubSandwich 0.2.2
203
204 ## New features
205
206 * Added `bread()` methods for all supported model classes.
207
208 * `vcovCR()` is now calculated using `bread()`, and carries attributes for `bread`, `est_mat`, and adjustment matrices.
209
210 * `vcovCR()` gains a `form` argument to obtain just the meat of the sandwich, or to use a user-specified bread matrix.
211
212
213 ## Minor improvements and bug fixes
214
215 * Refactored internal functions for degrees of freedom calculation to improve speed and memory usage.
216
217 * Bug fixes:
218 - updated `nobs.plm()` method to handle first-differenced models
219
220
221 # clubSandwich 0.2.1
222
223 * First version released on CRAN.