updates_old
Table of Contents
Older Package Updates
Older updates of the metafor package are archived on this page. More recent updates can be found here.
Version 3.0-2 (2021-06-02)
- the
metaforpackage now makes use of themathjaxrpackage to nicely render equations shown in the HTML help pages rma()can now also fit location-scale models- added
selmodel()for fitting a wide variety of selection models (and added the correspondingplot.rma.uni.selmodel()function for drawing the estimated selection function) rma.mv()gainsdfsargument and now provides an often better way for calculating the (denominator) degrees of freedom for approximate t- and F-tests whendfs="contain"- added
tes()function for the test of excess significance - added
regplot()function for drawing scatter plots / bubble plots based on meta-regression models - added
rcalc()for calculating the variance-covariance matrix of correlation coefficients andmatreg()for fitting regression models based on correlation/covariance matrices - added convenience functions
dfround()andvec2mat() - added
aggregate.escalc()function to aggregate multiple effect sizes or outcomes within studies/clusters regtest()now shows the 'limit estimate' of the (average) true effect when usingsei,vi,ninv, orsqrtninvas predictors (and the model does not contain any other moderators)vif()gainsbttargument and can now also compute generalized variance inflation factors; a properprint.vif.rma()function was also addedanova.rma()argumentLrenamed toX(the former still works, but is no longer documented)- argument
orderincumul()should now just be a variable, not the order of the variable, to be used for ordering the studies and must be of the same length as the original dataset that was used in the model fitting - similarly, vector arguments in various plotting functions such as
forest.rma()must now be of the same length as the original dataset that was used in the model fitting (any subsetting and removal ofNAsis automatically applied) - the various
leave1out()andcumul()functions now provide I^2 and H^2 also for fixed-effects models; accordingly,plot.cumul.rma()now also works with such models - fixed
levelnot getting passed down to the variouscumul()functions plot.cumul.rma()argumentaddgridrenamed togrid(the former still works, but is no longer documented)forest.default(),forest.rma(), andlabbe()gainplimargument and now provide more flexibility in terms of the scaling of the pointsforest.rma()gainscoloutargument (to adjust the color of the observed effect sizes or outcomes)- in the various
forest()functions, the right header is now suppressed whenannotate=FALSEandheader=TRUE funnel.default()andfunnel.rma()gainlabelandoffsetargumentsfunnel.default()andfunnel.rma()gainltyargument; the reference line is now drawn by default as a dotted line (like the line for the pseudo confidence region)- the
forestandfunnelarguments ofreporter.rma.uni()can now also be logicals to suppress the drawing of these plots - added
weightedargument tofsn()(for Orwin's method) - added some more transformation functions
bldiag()now properly handles ?x0 or 0x? matrices- p-values are still given to 2 digits even when
digits=1 summary.escalc()also provides the p-values (of the Wald-type tests); but when using thetransfargument, the sampling variances, standard errors, test statistics, and p-values are no longer shownrma.uni()no longer constrains a fixed tau^2 value to 0 when k=1- slight speedup in functions that repeatedly fit
rma.uni()models by skipping the computation of the pseudo R^2 statistic - started using the
pbapplypackage for showing progress bars, also when using parallel processing - to avoid potential confusion, all references to 'credibility intervals' have been removed from the documentation; these intervals are now exclusively referred to as 'prediction intervals'; in the output, the bounds are therefore indicated now as
pi.lbandpi.ub(instead ofcr.lbandcr.ub); the corresponding argument names were changed inaddpoly.default(); argumentaddcredwas changed toaddpredinaddpoly.rma()andforest.rma(); however, code using the old arguments names should continue to work - one can now use
weights(..., type="rowsum")for intercept-onlyrma.mvmodels (to obtain 'row-sum weights') simulate.rma()gainsolimargument; renamed theclimargument insummary.escalc()and the variousforest()functions toolimfor consistency (the oldclimargument should continue to work)- show nicer network graphs for
dat.hasselblad1998anddat.senn2013in the help files - added 23 datasets (
dat.anand1999,dat.assink2016,dat.baskerville2012,dat.bornmann2007,dat.cannon2006,dat.cohen1981,dat.craft2003,dat.crede2010,dat.dagostino1998,dat.damico2009,dat.dorn2007,dat.hahn2001,dat.kalaian1996,dat.kearon1998,dat.knapp2017,dat.landenberger2005,dat.lau1992,dat.lim2014,dat.lopez2019,dat.maire2019,dat.moura2021,dat.obrien2003,dat.vanhowe1999,dat.viechtbauer2021) - the package now runs a version check on startup in interactive sessions; setting the environment variable
METAFOR_VERSION_CHECKtoFALSEdisables this - refactored various functions (for cleaner/simpler code)
- improved the documentation a bit
Version 2.4-0 (2020-03-19)
- version jump to 2.4-0 for CRAN release (from now on, even minor numbers for CRAN releases, odd numbers for development versions)
- the various
forest()functions gainheaderargument escalc()gainsincludeargument- setting
verbose=3in model fitting functions setsoptions(warn=1) forest.rma()andforest.default()now throw informative errors when misusingorderandsubsetarguments- fixed failing tests due to the
stringsAsFactors=FALSEchange in the upcoming version of R print.infl.rma.uni()gainsinfonlyargument, to only show the influential studies- removed
MASSfromSuggests(no longer needed) - argument
bttcan now also take a string to grep for - added
optimParallelas possible optimizer inrma.mv() - added (for now undocumented) option to fit models in
rma.glmm()via theGLMMadaptivepackage (instead oflme4); to try this, use:control=list(package="GLMMadaptive") - started to use numbering scheme for 'devel' version (the number after the dash indicates the devel version)
- added
contrmat()function (for creating a matrix that indicates which groups have been compared against each other in each row of a dataset) - added
to.wide()function (for restructuring long format datasets into the wide format needed for contrast-based analyses) I^2andH^2are also shown in output for fixed-effects models- argument
gridinbaujat()can now also be a color name - added (for now undocumented)
timeargument to more functions that are computationally expensive - added (for now undocumented)
textposargument to the various forest functions - added a new dataset (
dat.graves2010) - added more tests
Version 2.1-0 (2019-05-13)
- added
formula()method for objects of classrma llplot()now also allows formeasure="GEN"; also, the documentation and y-axis label have been corrected to indicate that the function plots likelihoods (not log likelihoods)confint.rma.mv()now returns an object of classlist.confint.rmawhen obtaining CIs for all variance and correlation components of the model; added correspondingprint.list.confint.rma()function- moved
tolargument inpermutest()tocontroland renamed the argument tocomptol - added
PMMandGENQMestimators in rma.uni() - added
vif()function to get variance inflation factors - added
.glmultiobject for making the interaction with glmulti easier - added
reporter()andreporter.rma.uni()for dynamically generating analysis reports for objects of classrma.uni - output is now styled/colored when
crayonpackage is loaded (this only works on a 'proper' terminal with color support; also works in RStudio) - overhauled
plot.gosh.rma(); whenoutis specified, it now shows two distributions, one for the values when the outlier is included and one for the values when for outlier is excluded; dropped thehcolargument and addedborderargument - refactored
influence.rma.uni()to be more consistent internally with other functions;print.infl.rma.uni()andplot.infl.rma.uni()adjusted accordingly; functionscooks.distance.rma.uni(),dfbetas.rma.uni(), andrstudent.rma.uni()now callinfluence.rma.uni()for the computations rstudent.rma.uni()now computes the SE of the deleted residuals in such a way that it will yield identical results to a mean shift outlier model even when that model is fitted withtest="knha"rstandard.rma.uni()gainstypeargument, and can now also compute conditional residuals (it still computes marginal residuals by default)cooks.distance.rma.mv()gainsclusterargument, so that the Cook's distances can be computed for groups of estimatescooks.distance.rma.mv()gainsparallel,ncpus, andclarguments and can now make use of parallel processingcooks.distance.rma.mv()should be faster by using the estimates from the full model as starting values when fitting the models with the ith study/cluster deleted from the datasetcooks.distance.rma.mv()gainsreestimateargument; when set toFALSE, variance/correlation components are not reestimatedrstandard.rma.mv()gainsclusterargument for computing cluster-level multivariate standardized residuals- added
rstudent.rma.mv()anddfbetas.rma.mv() - smarter matching of elements in
newmods(when using a named vector) inpredict()that also works for models with interactions (thanks to Nicole Erler for pointing out the problem) rma.uni()andrma.mv()no longer issue (obvious) warnings when user constrainsviorVto 0 (i.e.,vi=0orV=0, respectively)rma.mv()does more intelligent filtering based onNAsinVmatrixrma.mv()now ensures strict symmetry of any (var-cov or correlation) matrices specified via theRargument- fixed
rma.mv()so checks onRargument run as intended; also fixed an issue when multiple formulas with slashes are specified viarandom(thanks to Andrew Loignon for pointing out the problem) - suppressed showing calls on some warnings/errors in
rma.mv() rma.mv()now allows for a continuous-time autoregressive random effects structure (struct="CAR") and various spatial correlation structures (struct="SPEXP","SPGAU","SPLIN","SPRAT", and"SPSPH")rma.mv()now allows forstruct="GEN"which models correlated random effects for any number of predictors, including continuous ones (i.e., this allows for 'random slopes')- in the various
forest()functions, whenoptions(na.action="na.pass")oroptions(na.action="na.exclude")and an annotation containsNA, this is now shown as a blank (instead ofNA [NA, NA]) - the various
forest()andaddpoly()functions gain afontsargument - the various
forest()functions gain atopargument - the various
forest()functions now show correct point sizes when the weights of the studies are exactly the same forest.cumul.rma()gains acolargumentfunnel.default()andfunnel.rma()can now take vectors as input for thecolandbgarguments (and also forpch); both functions also gain alegendargumentaddpoly()functions can now also show prediction interval bounds- removed 'formula interface' from
escalc(); until this actually adds some kind of extra functionality, this just makesescalc()more confusing to use escalc()can now compute the coefficient of variation ratio and the variability ratio for pre-post or matched designs ("CVRC","VRC")escalc()does a bit more housekeeping- added (currently undocumented) arguments
onlyo1,addyi, andaddvitoescalc()that allow for more flexibility when computing certain bias corrections and when computing sampling variances for measures that make use of theaddandtoarguments escalc()now setsadd=0for measures where the use of such a bias correction makes little sense; this applies to the following measures:"AS","PHI","RTET","IRSD","PAS","PFT","IRS", and"IRFT"; one can still force the use of the bias correction by explicitly setting theaddargument to some non-zero value- added
climargument tosummary.escalc() - added
ilimargument totrimfill() labbe()gainsltyargumentlabbe()now (invisibly) returns a data frame with the coordinates of the points that were drawn (which may be useful for manual labeling of points in the plot)- added a print method for
profile.rmaobjects profile.rma.mv()now check whether any of the profiled log-likelihood values is larger than the log-likelihood of the fitted model (using numerical tolerance given bylltol) and issues a warning if soprofile.rma.uni(),profile.rma.mv(), andplot.profile.rma()gainclineargument;plot.profile.rma()gainsxlim,ylab, andmainarguments- fixed an issue with
robust.rma.mv()when the model was fitted withsparse=TRUE(thanks to Roger Martineau for noting the problem) - various method functions (
fitted(),resid(),predict(), etc.) behave in a more consistent manner when model omitted studies with missings predict.rma()gainsvcovargument; when set toTRUE, the variance-covariance matrix of the predicted values is also returnedvcov.rma()can now also return the variance-covariance matrix of the fitted values (type="fitted") and the residuals (type="resid")- added
`$<-`andas.matrix()methods forlist.rmaobjects - fixed error in
simulate.rma()that would generate too many samples forrma.mvmodels - added undocumented argument
timeto all model fitting functions; if set toTRUE, the model fitting time is printed - added more tests (also for parallel operations); also, all tests updated to use proper tolerances instead of rounding
- reorganized the documentation a bit
Version 2.0-0 (2017-06-22)
- added
simulate()method forrmaobjects; addedMASStoSuggests(since simulating forrma.mvobjects requiresmvrnorm()fromMASS) cooks.distance.rma.mv()now works properly even when there are missing values in the dataresiduals()gainstypeargument and can compute Pearson residuals- the
newmodsargument inpredict()can now be a named vector or a matrix/data frame with column names that get properly matched up with the variables in the model - added
ranef.rma.mv()for extracting the BLUPs of the random effects forrma.mvmodels - all functions that repeatedly refit models now have the option to show a progress bar
- added
ranktest.default(), so user can now pass the outcomes and corresponding sampling variances directly to the function - added
regtest.default(), so user can now pass the outcomes and corresponding sampling variances directly to the function funnel.default()gainssubsetargumentfunnel.default()andfunnel.rma()gaincolandbgargumentsplot.profile.rma()gainsylabargument- more consistent handling of
robust.rmaobjects - added a print method for
rma.goshobjects - the (log) relative risk is now called the (log) risk ratio in all help files, plots, code, and comments
escalc()can now compute outcome measures based on paired binary data ("MPRR","MPOR","MPRD","MPORC", and"MPPETO")escalc()can now compute (semi-)partial correlation coefficients ("PCOR","ZPCOR","SPCOR")escalc()can now compute measures of variability for single groups ("CVLN","SDLN") and for the difference in variability between two groups ("CVR","VR"); also the log transformed mean ("MNLN") has been added for consistencyescalc()can now compute the sampling variance formeasure="PHI"for studies using stratified sampling (vtpye="ST")- the
`[`method forescalcobjects now properly handles theniandslabattributes and does a better job of cleaning out superfluous variable name information - added
rbind()method forescalcobjects - added
as.data.frame()method forlist.rmaobjects - added a new dataset (
dat.pagliaro1992) for another illustration of a network meta-analysis - added a new dataset (
dat.laopaiboon2015) on the effectiveness of azithromycin for treating lower respiratory tract infections rma.uni()andrma.mv()now check if the ratio of the largest to smallest sampling variance is very large; results may not be stable then (and very large ratios typically indicate wrongly coded data)- model fitting functions now check if extra/superfluous arguments are specified via
...and issues are warning if so - instead of defining own generic
ranef(), importranef()fromnlme - improved output formatting
- added more tests (but disabled a few tests on CRAN to avoid some issues when R is compiled with
--disable-long-double) - some general code cleanup
- renamed
diagram_metafor.pdfvignette to justdiagram.pdf - minor updates in the documentation
Version 1.9-9 (2016-09-25)
- started to use git as version control system, GitHub to host the repository (https://github.com/wviechtb/metafor) for the development version of the package, Travis CI as continuous integration service (https://travis-ci.org/wviechtb/metafor), and Codecov for automated code coverage reporting (https://app.codecov.io/gh/wviechtb/metafor)
- argument
knhainrma.uni()and argumenttdistinrma.glmm()andrma.mv()are now superseded by argumenttestin all three functions; for backwards compatibility, theknhaandtdistarguments still work, but are no longer documented rma(yi, vi, weights=1, test="knha")now yields the same results asrma(yi, vi, weighted=FALSE, test="knha")(but use of the Knapp and Hartung method in the context of an unweighted analysis remains an experimental feature)- one can now pass an
escalcobject directly torma.uni(), which then tries to automatically determine theyiandvivariables in the data frame (thanks to Christian Röver for the suggestion) escalc()can now also be used to convert a regular data frame to anescalcobject- for
measure="UCOR", the exact bias-correction is now used (instead of the approximation); whenvtype="UB", the exact equation is now used to compute the unbiased estimate of the variance of the bias-corrected correlation coefficient; hencegslis now a suggested package (needed to compute the hypergeometric function) and is loaded when required cooks.distance()now also works withrma.mvobjects; and since model fitting can take some time, an option to show a progress bar has been added- fixed an issue with
robust.rma.mv()throwing errors when the model was fitted withsparse=TRUE - fixed an error with
robust.rma.mv()when the model was fitted with user-defined weights (or a user-defined weight matrix) - added
ranef()for extracting the BLUPs of the random effects (only forrma.uniobjects at the moment) - reverted back to the pre-1.1-0 way of computing p-values for individual coefficients in
permutest.rma.uni(), that is, the p-value is computed withmean(abs(z_perm) >= abs(z_obs) - tol)(wheretolis a numerical tolerance) permutest.rma.uni()gainspermciargument, which can be used to obtain permutation-based CIs of the model coefficients (note that this is computationally very demanding and may take a long time to complete)rma.glmm()continues to work even when the saturated model cannot be fitted (although the tests for heterogeneity are not available then)rma.glmm()now allows control over the arguments used formethod.args(viacontrol=list(hessianCtrl=list(...))) passed tohessian()(from thenumDerivpackage) when usingmodel="CM.EL"andmeasure="OR"- in
rma.glmm(), defaultmethod.argsvalue forrpassed tohessian()has been increased to 16 (while this slows things down a bit, this appears to improve the accuracy of the numerical approximation to the Hessian, especially when tau^2 is close to 0) - the various
forest()andaddpoly()functions now have a new argument calledwidth, which provides manual control over the width of the annotation columns; this is useful when creating complex forest plots with a monospaced font and we want to ensure that all annotations are properly lined up at the decimal point - the annotations created by the various
forest()andaddpoly()functions are now a bit more compact by default - more flexible
efacargument in the variousforest()functions - trailing zeros in the axis labels are now dropped in forest and funnel plots by default; but trailing zeros can be retained by specifying a numeric (and not an integer) value for the
digitsargument - added
funnel.default(), which directly takes as input a vector with the observed effect sizes or outcomes and the corresponding sampling variances, standard errors, and/or sample sizes - added
plot.profile.rma(), a plot method for objects returned by theprofile.rma.uni()andprofile.rma.mv()functions - simplified
baujat.rma.uni(),baujat.rma.mh(), andbaujat.rma.peto()tobaujat.rma(), which now handles objects of classrma.uni,rma.mh, andrma.peto baujat.rma()gains argumentsymbolfor more control over the plotting symbollabbe()gains agridargument- more logical placement of labels in
qqnorm.rma.uni(),qqnorm.rma.mh(), andqqnorm.rma.peto()functions (and more control thereof) qqnorm.rma.uni()gainsltyargument- added
gosh.rma()andplot.gosh.rma()for creating GOSH (i.e., graphical display of study heterogeneity) plots based on Olkin et al. (2012) - in the (rare) case where all observed outcomes are exactly equal to each other,
test="knha"(i.e.,knha=TRUE) inrma()now leads to more appropriate results - updated datasets so those containing precomputed effect size estimates or observed outcomes are already declared to be
escalcobjects - added new datasets (
dat.egger2001anddat.li2007) on the effectiveness of intravenous magnesium in acute myocardial infarction methodspackage is now underDepends(in addition toMatrix), so thatrma.mv(..., sparse=TRUE)always works, even under Rscript- some general code cleanup
- added more tests (and used a more consistent naming scheme for tests)
Version 1.9-8 (2015-05-28)
- due to more stringent package testing, it is increasingly difficult to ensure that the package passes all checks on older versions of R; from now on, the package will therefore require, and be checked under, only the current (and the development) version of R
- added
graphics,grDevices, andmethodsto Imports (due to recent change in how CRAN checks packages) - the
structargument forrma.mv()now also allows for"ID"and"DIAG", which are identical to the"CS"and"HCS"structures, but with the correlation parameter fixed to 0 - added
robust()for (cluster) robust tests and confidence intervals forrma.uniandrma.mvmodels (this uses a robust sandwich-type estimator of the variance-covariance matrix of the fixed effects along the lines of the Eicker-Huber-White method) confint()now works for models fitted with therma.mv()function; for variance and correlation parameters, the function provides profile likelihood confidence intervals; the output generated by theconfint()function has been adjusted in general to make the formatting more consistent across the different model types- for objects of class
rma.mv,profile()now provides profile plots for all (non-fixed) variance and correlation components of the model when no component is specified by the user (via thesigma2,tau2,rho,gamma2, orphiarguments) - for
measure="MD"andmeasure="ROM", one can now choose betweenvtype="LS"(the default) andvtype="HO"; the former computes the sampling variances without assuming homoscedasticity, while the latter assumes homoscedasticity - multiple model objects can now be passed to the
fitstats(),AIC(), andBIC()functions - check for duplicates in the
slabargument is now done *after* any subsetting is done (as suggested by Michael Dewey) rma.glmm()now again works when usingadd=0, in which case some of the observed outcomes (e.g., log odds or log odds ratios) may beNA- when using
rma.glmm()withmodel="CM.EL", the saturated model (used to compute the Wald-type and likelihood ratio tests for the presence of (residual) heterogeneity) often fails to converge; the function now continues to run (instead of stopping with an error) and simply omits the test results from the output - when using
rma.glmm()withmodel="CM.EL"and inversion of the Hessian fails via the Choleski factorization, the function now makes another attempt via the QR decomposition (even when this works, a warning is issued) - for
rma.glmm(), BIC and AICc values were switched around; corrected - more use of
suppressWarnings()is made when functions repeatedly need to fit the same model, such ascumul(),influence(), andprofile(); that way, one does not get inundated with the same warning(s) - some (overdue) updates to the documentation
Version 1.9-7 (2015-05-22)
- default optimizer for
rma.mv()changed tonlminb()(instead ofoptim()with"Nelder-Mead"); extensive testing indicated thatnlminb()(and alsooptim()with"BFGS") is typically quicker and more robust; note that this is in principle a non-backwards compatible change, but really a necessary one; and you can always revert to the old behavior withcontrol=list(optimizer="optim", optmethod="Nelder-Mead") - all tests have been updated in accordance with the recommended syntax of the
testthatpackage; for example,expect_equivalent(x,y)is used instead oftest_that(x, is_equivalent_to(y)) - changed a few
is_identical_to()comparisons toexpect_equivalent()ones (that failed on Sparc Solaris)
Version 1.9-6 (2015-05-07)
funnel()now works again forrma.glmmobjects (note to self: quit breaking things that work!)rma.glmm()will now only issue a warning (and not an error) when the Hessian for the saturated model cannot be inverted (which is needed to compute the Wald-type test for heterogeneity, so the test statistic is then simply set toNA)rma.mv()now allows for two terms of the form~ inner | outer; the variance components corresponding to such a structure are calledgamma2and correlations are calledphi; other functions that work with objects of classrma.mvhave been updated accordinglyrma.mv()now provides (even) more optimizer choices:nlm()from thestatspackage,hjk()andnmk()from thedfoptimpackage, anducminf()from theucminfpackage; choose the desired optimizer via thecontrolargument (e.g.,control=list(optimizer="nlm"))profile.rma.uni()andprofile.rma.mv()now can do parallel processing (which is especially relevant forrma.mvobjects, where profiling is crucial and model fitting can be slow)- the various
confint()functions now have atransfargument (to apply some kind of transformation to the model coefficients and confidence interval bounds); coefficients and bounds for objects of classrma.mhandrma.petoare no longer automatically transformed - the various
forest()functions no longer enforce that the actual x-axis limits (alim) encompass the observed outcomes to be plotted; also, outcomes below or above the actual x-axis limits are no longer shown - the various
forest()functions now provide control over the horizontal lines (at the top/bottom) that are automatically added to the plot via theltyargument (this also allows for removing them); also, the vertical reference line is now placed *behind* the points/CIs forest.default()now has argumentcolwhich can be used to specify the color(s) to be used for drawing the study labels, points, CIs, and annotations- the
efacargument forforest.rma()now also allows two values, the first for the arrows and CI limits, the second for summary estimates - corrected some axis labels in various plots when
measure="PLO" - axes in
labbe()plots now have"(Group 1)"and"(Group 2)"added by default anova.rma()gains argumentLfor specifying linear combinations of the coefficients in the model that should be tested to be zero- in case removal of a row of data would lead to one or more inestimable model coefficients,
baujat(),cooks.distance(),dfbetas(),influence(), andrstudent()could fail forrma.uniobjects; such cases are now handled properly - for models with moderators, the
predict()function now shows the study labels when they have been specified by the user (andnewmodsis not used) - if there is only one fixed effect (model coefficient) in the model, the
print.infl.rma.uni()function now shows the DFBETAS values with the other case diagnostics in a single table (for easier inspection); if there is more than one fixed effect, a separate table is still used for the DFBETAS values (with one column for each coefficient) - added
measure="SMCRH"to theescalc()function for the standardized mean change using raw score standardization with heteroscedastic population variances at the two measurement occasions - added
measure="ROMC"to theescalc()function for the (log transformed) ratio of means (response ratio) when the means reflect two measurement occasions (e.g., for a single group of people) and hence are correlated - added own function for computing/estimating the tetrachoric correlation coefficient (for
measure="RTET"); package therefore no longer suggestspolycorbut now suggestmvtnorm(which is loaded as needed) - element
fillreturned bytrimfill.rma.uni()is now a logical vector (instead of a 0/1 dummy variable) print.list.rma()now also returns the printed results invisibly as a data frame- added a new dataset (
dat.senn2013) as another illustration of a network meta-analysis metafornow depends on at least version 3.1.0 of R
Version 1.9-5 (2014-11-24)
- moved the
statsandMatrixpackages fromDependstoImports; as a result, had to addutilstoImports; moved theFormulapackage fromDependstoSuggests - added
update.rma()function (for updating/refitting a model); model objects also now store and keep the call - the
vcov()function now also extracts the marginal variance-covariance matrix of the observed effect sizes or outcomes from a fitted model (of classrma.uniorrma.mv) rma.mv()now makes use of the Cholesky decomposition when there is arandom = ~ inner | outerformula andstruct="UN"; this is numerically more stable than the old approach that avoided non-positive definite solutions by forcing the log-likelihood to be-Infin those cases; the old behavior can be restored withcontrol = list(cholesky=FALSE)rma.mv()now requires theinnervariable in an~ inner | outerformula to be a factor or character variable (except whenstructis"AR"or"HAR"); use~ factor(inner) | outerin case it isn'tanova.rma.uni()function changed toanova.rma()that works now for bothrma.uniandrma.mvobjects- the
profile.rma.mv()function now omits the number of the variance or correlation component from the plot title and x-axis label when the model only includes one of the respective parameters profile()functions now pass on the...argument also to thetitle()function used to create the figure titles (esp. relevant when using thecex.mainargument)- the
drop00argument of therma.mh()andrma.peto()functions now also accepts a vector with two logicals, the first applies when calculating the observed outcomes, the second when applying the Mantel-Haenszel or Peto's method weights.rma.uni()now shows the correct weights whenweighted=FALSE- argument
showweightrenamed toshowweightsin theforest.default()andforest.rma()functions (more consistent with the naming of the variousweights()functions) - added
model.matrix.rma()function (to extract the model matrix from objects of classrma) funnel()andradial()now (invisibly) return data frames with the coordinates of the points that were drawn (may be useful for manual labeling of points in the plots)permutest.rma.uni()function now uses a numerical tolerance when making comparisons (>= or ⇐) between an observed test statistic and the test statistic under the permuted data; when using random permutations, the function now ensures that the very first permutation correspond to the original data- corrected some missing/redundant row/column labels in some output
- most
require()calls replaced withrequireNamespace()to avoid altering the search path (hopefully this won't break stuff ...) - some non-visible changes including more use of some (non-exported) helper functions for common tasks
- dataset
dat.collins91985aupdated (including all reported outcomes and some more information about the various trials) - oh, and guess what? I updated the documentation ...
Version 1.9-4 (2014-07-30)
- added
method="GENQ"torma.uni()for the generalized Q-statistic estimator of tau^2, which allows for used-defined weights (note: the DL and HE estimators are just special cases of this method) - when the model was fitted with
method="GENQ", thenconfint()will now use the generalized Q-statistic method to construct the corresponding confidence interval for tau^2 (thanks to Dan Jackson for the code); the iterative method used to obtain the CI makes use of Farebrother's algorithm as implemented in theCompQuadFormpackage - slight improvements in how the
rma.uni()function handles non-positive sampling variances rma.uni(),rma.mv(), andrma.glmm()now try to detect and remove any redundant predictors before the model fitting; therefore, if there are exact linear relationships among the predictor variables (i.e., perfect multicollinearity), terms are removed to obtain a set of predictors that is no longer perfectly multicollinear (a warning is issued when this happens); note that the order of how the variables are specified in the model formula can influence which terms are removed- the last update introduced an error in how hat values were computed when the model was fitted with the
rma()function using the Knapp & Hartung method (i.e., whenknha=TRUE); this has been fixed regtest()no longer works (for now) withrma.mvobjects (it wasn't meant to in the first place); if you want to run something along the same lines, just consider adding some measure of the precision of the observed outcomes (e.g., their standard errors) as a predictor to the model- more optimizers are now available for the
rma.mv()function via thenloptrpackage by settingcontrol = list(optimizer="nloptr"); when using this optimizer, the default is to use the BOBYQA implementation from that package with a relative convergence criterion of 1e-8 on the function value (see documentation on how to change these defaults) predict.rma()function now works forrma.mvobjects with multiple tau^2 values even if the user specifies thenewmodsargument but not thetau2.levelsargument (but a warning is issued and the prediction intervals are not computed)- argument
var.namesnow works properly inescalc()when the user has not made use of thedataargument (thanks to Jarrett Byrnes for bringing this to my attention) - added
plot()function for cumulative random-effects models results as obtained with thecumul.rma.uni()function; the plot shows the model estimate on the x-axis and the corresponding tau^2 estimate on the y-axis in the cumulative order of the results - fixed the omitted offset term in the underlying model fitted by the
rma.glmm()function whenmethod="ML",measure="IRR", andmodel="UM.FS", that is, when fitting a mixed-effects Poisson regression model with fixed study effects to two-group event count data (thanks to Peter Konings for pointing out this error) - added two new datasets (
dat.bourassa1996,dat.riley2003) - added function
replmiss()(just a useful helper function) - package now uses
LazyData: TRUE - some improvements to the documentation (do I still need to mention this every time?)
Version 1.9-3 (2014-05-05)
- some minor tweaks to
rma.uni()that should be user transparent rma.uni()now has aweightsargument, allowing the user to specify arbitrary user-defined weights; all functions affected by this have been updated accordingly- better handling of mismatched length of
yiandnivectors inrma.uni()andrma.mv()functions - subsetting is now handled as early as possible within functions with subsetting capabilities; this avoids some (rare) cases where studies ultimately excluded by the subsetting could still affect the results
- some general tweaks to
rma.mv()that should make it a bit faster - argument
Vofrma.mv()now also accepts a list of var-cov matrices for the observed effects or outcomes; from the list elements, the full (block diagonal) var-cov matrixVis then automatically constructed rma.mv()now has a new argumentWallowing the user to specify arbitrary user-defined weights or an arbitrary weight matrixrma.mv()now has a new argumentsparse; by setting this toTRUE, the function uses sparse matrix objects to the extent possible; this can speed up model fitting substantially for certain models (hence, themetaforpackage now depends on theMatrixpackage)rma.mv()now allows forstruct="AR"andstruct="HAR", to fit models with (heteroscedastic) autoregressive (AR1) structures among the true effects (useful for meta-analyses of studies reporting outcomes at multiple time points)rma.mv()now has a new argumentRscalewhich can be used to control how matrices specified via theRargument are scaled (see docs for more details)rma.mv()now only checks for missing values in the rows of the lower triangular part of theVmatrix (including the diagonal); this way, ifVi = matrix(c(.5,NA,NA,NA), nrow=2, ncol=2)is the var-cov matrix of the sampling errors for a particular study with two outcomes, then only the second row/column needs to be removed before the model fitting (and not the entire study)- added five new datasets (
dat.begg1989,dat.ishak2007,dat.fine1993,dat.konstantopoulos2011, anddat.hasselblad1998) to provide further illustrations of the use of therma.mv()function (for meta-analyses combining controlled and uncontrolled studies, for meta-analyses of longitudinal studies, for multilevel meta-analyses, and for network meta-analyses / mixed treatment comparison meta-analyses) - added
rstandard.rma.mv()function to compute standardized residuals for models fitted with therma.mv()function (rstudent.rma.mv()to be added at a later point); also addedhatvalues.rma.mv()for computing the hat values andweights.rma.uni()for computing the weights (i.e., the diagonal elements of the weight matrix) - the various
weights()functions now have a new argumenttypeto indicate whether only the diagonal elements of the weight matrix (default) or the entire weight matrix should be returned - the various
hatvalues()functions now have a new argumenttypeto indicate whether only the diagonal elements of the hat matrix (default) or the entire hat matrix should be returned predict.rma()function now works properly forrma.mvobjects (also has a new argumenttau2.levelsto specify, where applicable, the levels of the inner factor when computing prediction intervals)forest.rma()function now provides a bit more control over the color of the summary polygon and is now compatible withrma.mvobjects; also, has a new argumentlty, which provides more control over the line type for the individual CIs and the prediction intervaladdpoly.default()andaddpoly.rma()now have aborderargument (for consistency with theforest.rma()function);addpoly.rma()now yields the correct CI bounds when the model was fitted withknha=TRUEforest.cumul.rma()now provides the correct CI bounds when the models were fitted with the Knapp & Hartung method (i.e., whenknha=TRUEin the originalrma()function call)- the various
forest()functions now return information about the chosen values for argumentsxlim,alim,at,ylim,rows,cex,cex.lab, andcex.axisinvisibly (useful for tweaking the default values); thanks to Michael Dewey for the suggestion - the various
forest()functions now have a new argument,clim, to set limits for the confidence/prediction interval bounds cumul.mh()andcumul.peto()now get the order of the studies right when there are missing values in the data- the
transfargument ofleave1out.rma.mh(),leave1out.rma.peto(),cumul.rma.mh(), andcumul.rma.peto()should now be used to specify the actual function for the transformation (the former behavior of setting this argument toTRUEto exponentiate log RRs, log ORs, or log IRRs still works for back-compatibility); this is more consistent with how thecumul.rma.uni()andleave1out.rma.uni()functions work and is also more flexible - added
bldiag()function to construct a block diagonal matrix from (a list of) matrices (may be needed to construct theVmatrix when using therma.mv()function);bdiag()function from theMatrixpackage does the same thing, but creates sparse matrix objects profile.rma.mv()now has astartmethodargument; by setting this to"prev", successive model fits are started at the parameter estimates from the previous model fit; this may speed things up a bit; also, the method for automatically choosing thexlimvalues has been changed- slight improvement to
profile.rma.mv()function, which would throw an error if the last model fit did not converge - added a new dataset (
dat.linde2005) for replication of the analyses in Viechtbauer (2007) - added a new dataset (
dat.molloy2014) for illustrating the meta-analysis of (r-to-z transformed) correlation coefficients - added a new dataset (
dat.gibson2002) to illustrate the combined analysis of standardized mean differences and probit transformed risk differences - computations in
weights.mh()slightly changed to prevent integer overflows for large counts - unnecessary warnings in
transf.ipft.hm()are now suppressed (cases that raised those warnings were already handled correctly) - in
predict(),blup(),cumul(), andleave1out(), when using thetransfargument, the standard errors (which areNA) are no longer shown in the output - argument
slabin various functions will now also accept non-unique study labels;make.unique()is used as needed to make them unique vignettes("metafor")andvignettes("metafor_diagram")work again (yes, I know they are not true vignettes in the strict sense, but I think they should show up on the CRAN website for the package and using a minimal valid Sweave document that is recognized by the R build system makes that happen)escalc()and itssummary()method now keep better track when the data frame contains multiple columns with outcome or effect size values (and corresponding sampling variances) for print formatting; also simplified the class structure a bit (and hence,print.summary.escalc()removed)summary.escalc()has a new argumentH0to specify the value of the outcome under the null hypothesis for computing the test statistics- added measures
"OR2DN"and"D2ORN"toescalc()for transforming log odds ratios to standardized mean differences and vice-versa, based on the method of Cox & Snell (1989), which assumes normally distributed response variables within the two groups before the dichotomization permutest.rma.uni()function now catches an error when the number of permutations requested is too large (for R to even create the objects to store the results in) and produces a proper error messagefunnel.rma()function now allows theyaxisargument to be set to"wi"so that the actual weights (in %) are placed on the y-axis (useful when arbitrary user-defined have been specified)- for
rma.glmm(), the control argumentoptCtrlis now used for passing control arguments to all of the optimizers (hence, control argumentsnlminbCtrlandminqaCtrlare now defunct) rma.glmm()should not throw an error anymore when including only a single moderator/predictor in the modelpredict.rma()now returns an object of classlist.rma(therefore, functionprint.predict.rma()has been removed)- for
rma.listobjects, added`[`,head(), andtail()methods - automated testing using the
testthatpackage (still many more tests to add, but finally made a start on this) - encoding changed to UTF-8 (to use 'foreign characters' in the docs and to make the HTML help files look a bit nicer)
- guess what? some improvements to the documentation! (also combined some of the help files to reduce the size of the manual a bit; and yes, it's still way too big)
Version 1.9-2 (2013-10-07)
- added function
rma.mv()to fit multivariate/multilevel meta-analytic models via appropriate linear (mixed-effects) models; this function allows for modeling of non-independent sampling errors and/or true effects and can be used for network meta-analyses, meta-analyses accounting for phylogenetic relatedness, and other complicated meta-analytic data structures - added the AICc to the information criteria computed by the various model fitting functions
- if the value of tau^2 is fixed by the user via the corresponding argument in
rma.uni(), then tau^2 is no longer counted as an additional parameter for the computation of the information criteria (i.e., AIC, BIC, and AICc) rma.uni(),rma.glmm(), andrma.mv()now use a more stringent check whether the model matrix is of full rank- added
profile()method functions for objects of classrma.uniandrma.mv(can be used to obtain a plot of the profiled log-likelihood as a function of a specific variance component or correlation parameter of the model) predict.rma()function now has aninterceptargument that allows the user to decide whether the intercept term should be included when calculating the predicted values (rare that this should be changed from the default)- for
rma.uni(),rma.glmm(), andrma.mv(), thecontrolargument can now also accept an integer value; values > 1 generate more verbose output about the progress inside of the function rma.glmm()has been updated to work withlme41.0.x for fitting various models; as a result,model="UM.RS"can only usenAGQ=1at the moment (hopefully this will change in the future)- the
controlargument ofrma.glmm()can now be used to pass all desired control arguments to the various functions and optimizers used for the model fitting (admittedly the use of lists within this argument is a bit unwieldy, but much more flexible) rma.mh()andrma.peto()also now have a 'verbose' argument (not really needed, but added for sake of consistency across functions)- a bit of code reorganization (should be user transparent)
- vignettes (
metaforandmetafor_diagram) are now just 'other files' in the doc directory (as these were not true vignettes to begin with) - some improvements to the documentation (as always)
Version 1.9-1 (2013-07-20)
rma.mh()now also implements the Mantel-Haenszel method for incidence rate differences (measure="IRD")- when analyzing incidence rate ratios (
measure="IRR") with therma.mh()function, the Mantel-Haenszel test for person-time data is now also provided rma.mh()has a new argumentcorrect(default isTRUE) to indicate whether the continuity correction should be applied when computing the (Cochran-)Mantel-Haenszel test statistic- renamed elements
CMHandCMHp(for the Cochran-Mantel-Haenszel test statistic and corresponding p-value) toMHandMHp - added function
baujat()to create Baujat plots - added a new dataset (
dat.pignon2000) to illustrate the use of thebaujat()function - added function
to.table()to convert data from vector format into the corresponding table format - added function
to.long()to convert data from vector format into the corresponding long format rma.glmm()now even runs when k=1 (yielding trivial results)- for models with an intercept and moderators,
rma.glmm()now internally rescales (non-dummy) variables to z-scores during the model fitting (this improves the stability of the model fitting, especially whenmodel="CM.EL"); results are given after back-scaling, so this should be transparent to the user - in
rma.glmm(), default number of quadrature points (nAGQ) is now 7 (setting this to 100 was a bit overkill) - a few more error checks here and there for misspecified arguments
- some improvements to the documentation
Version 1.9-0 (2013-06-21)
- vignette renamed to 'metafor' so
vignette("metafor")works now - added a diagram to the documentation, showing the various functions in the
metaforpackage (and how they relate to each other); can be loaded withvignette("metafor_diagram") anova.rma.uni()function can now also be used to test (sub)sets of model coefficients with a Wald-type test when a single model is passed to the function- the pseudo R^2 statistic is now automatically calculated by the
rma.uni()function and supplied in the output (only for mixed-effects models and when the model includes an intercept, so that the random-effects model is clearly nested within the mixed-effects model) - component
VAFis now calledR2inanova.rma.uni()function - added function
hc()that carries out a random-effects model analysis using the method by Henmi and Copas (2010); thanks to Michael Dewey for the suggestion and providing the code - added new dataset (
dat.lee2004), which was used in the article by Henmi and Copas (2010) to illustrate their method - fixed missing x-axis labels in the
forest()functions rma.glmm()now computes Hessian matrices via thenumDerivpackage whenmodel="CM.EL"andmeasure="OR"(i.e., for the conditional logistic model with exact likelihood); sonumDerivis now a suggested package and is loaded withinrma.glmm()when requiredtrimfill.rma.uni()now also implements the "Q0" estimator (although the "L0" and "R0" estimators are generally to be preferred)trimfill.rma.uni()now also calculates the SE of the estimated number of missing studies and, for estimator "R0", provides a formal test of the null hypothesis that the number of missing studies on a given side is zero- added new dataset (
dat.bangertdrowns2004) - the
levelargument in various functions now either accepts a value representing a percentage or a proportion (values greater than 1 are assumed to be a percentage) summary.escalc()now computes confidence intervals correctly when using thetransfargument- computation of Cochran-Mantel-Haenszel statistic in
rma.mh()changed slightly to avoid integer overflow with very big counts - some internal improvements with respect to object attributes that were getting discarded when subsetting
- some general code cleanup
- some improvements to the documentation
Version 1.8-0 (2013-04-11)
- added additional clarifications about the change score outcome measures (
"MC","SMCC", and"SMCR") to the help file for theescalc()function and changed the code so that"SMCR"no longer expects argumentsd2ito be specified (which is not needed anyways) (thanks to Markus Kösters for bringing this to my attention) - sampling variance for the biserial correlation coefficient (
"RBIS") is now calculated in a slightly more accurate way llplot()now properly scales the log-likelihoods- argument
whichin theplot.infl.rma.uni()function has been replaced with argumentplotinfwhich can now also be set toFALSEto suppress plotting of the various case diagnostics altogether - labeling of the axes in
labbe()plots is now correct for odds ratios (and transformations thereof) - added two new datasets (
dat.nielweise2007anddat.nielweise2008) to illustrate some methods/models from therma.glmm()function - added a new dataset (
dat.yusuf1985) to illustrate the use ofrma.peto() - test for heterogeneity is now conducted by the
rma.peto()function exactly as described by Yusuf et al. (1985) - in
rma.glmm(), default number of quadrature points (nAGQ) is now 100 (which is quite a bit slower, but should provide more than sufficient accuracy in most cases) - the standard errors of the HS and DL estimators of tau^2 are now correctly computed when tau^2 is prespecified by the user in the
rma()function; in addition, the standard error of the SJ estimator is also now provided when tau^2 is prespecified rma.uni()andrma.glmm()now use a better method to check whether the model matrix is of full rank- I^2 and H^2 statistics are now also calculated for mixed-effects models by the
rma.uni()andrma.glmm()function;confint.rma.uni()provides the corresponding confidence intervals forrma.unimodels - various
print()methods now have a new argument calledsignif.stars, which defaults togetOption("show.signif.stars")(which by default isTRUE) to determine whether the infamous 'significance stars' should be printed - slight changes in wording in the output produced by the
print.rma.uni()andprint.rma.glmm()functions - some improvements to the documentation
Version 1.7-0 (2013-02-06)
- added
rma.glmm()function for fitting of appropriate generalized linear (mixed-effects) models when analyzing odds ratios, incidence rate ratios, proportions, or rates; the function makes use of thelme4andBiasedUrnpackages; these are now suggested packages and loaded withinrma.glmm()only when required (this makes for faster loading of themetaforpackage) - added several method functions for objects of class
rma.glmm(not all methods yet implemented; to be completed in the future) rma.uni()now allows the user to specify a formula for theyiargument, so instead ofrma(yi, vi, mods=~mod1+mod2), one can specify the same model withrma(yi~mod1+mod2, vi)rma.uni()now has aweightsargument to specify the inverse of the sampling variances (instead of using theviorseiarguments); for now, this is all this argument should be used for (in the future, this argument may potentially be used to allow the user to define alternative weights)rma.uni()now checks whether the model matrix is not of full rank and issues an error accordingly (instead of the rather cryptic error that was issued before)rma.uni()now has averboseargumentcoef.rma()now returns only the model coefficients (this change was necessary to make the package compatible with themultcomppackage; seehelp(rma)for an example); usecoef(summary())to obtain the full table of results- the
escalc()function now does some more extensive error checking for misspecified data and some unusual cases appendargument is nowTRUEby default in theescalc()function- objects generated by the
escalc()function now have their own class - added
print()andsummary()methods for objects of classescalc - added
`[`andcbind()methods for objects of classescalc - added a few additional arguments to the
escalc()function (i.e.,slab,subset,var.names,replace,digits) - added
drop00argument to theescalc(),rma.uni(),rma.mh(), andrma.peto()functions - added
"MN","MC","SMCC", and"SMCR"measures to theescalc()andrma.uni()functions for the raw mean, the raw mean change, and the standardized mean change (with change score or raw score standardization) as possible outcome measures - the
"IRFT"measure in theescalc()andrma.uni()functions is now computed with1/2*(sqrt(xi/ti) + sqrt(xi/ti+1/ti))which is more consistent with the definition of the Freeman-Tukey transformation for proportions - added
"RTET"measure to theescalc()andrma.uni()functions to compute the tetrachoric correlation coefficient based on 2x2 table data (thepolycorpackage is therefore now a suggested package, which is loaded withinescalc()only when required) - added
"RPB"and"RBIS"measures to theescalc()andrma.uni()functions to compute the point-biserial and biserial correlation coefficient based on means and standard deviations - added
"PBIT"and"OR2D"measures to theescalc()andrma.uni()functions to compute the standardized mean difference based on 2x2 table data - added the
"D2OR"measure to theescalc()andrma.uni()functions to compute the log odds ratio based on the standardized mean difference - added
"SMDH"measure to theescalc()andrma.uni()functions to compute the standardized mean difference without assuming equal population variances - added
"ARAW","AHW", and"ABT"measures to theescalc()andrma.uni()functions for the raw value of Cronbach's alpha, the transformation suggested by Hakstian & Whalen (1976), and the transformation suggested by Bonett (2002) for the meta-analysis of reliability coefficients (seehelp(escalc)for details) - corrected a small mistake in the equation used to compute the sampling variance of the phi coefficient (
measure="PHI") in theescalc()function - the
permutest.rma.uni()function now uses an algorithm to find only the unique permutations of the model matrix (which may be much smaller than the total number of permutations), making the exact permutation test feasible in a larger set of circumstances (thanks to John Hodgson for making me aware of this issue and to Hans-Jörg Viechtbauer for coming up with a recursive algorithm for finding the unique permutations) - prediction interval in
forest.rma()is now indicated with a dotted (instead of a dashed) line; ends of the interval are now marked with vertical bars - completely rewrote the
funnel.rma()function which now supports many more options for the values to put on the y-axis;trimfill.rma.uni()function was adapted accordingly - removed the
niargument from theregtest.rma()function; instead, sample sizes can now be explicitly specified via theniargument when using therma.uni()function (i.e., whenmeasure="GEN"); theescalc()function also now adds information on thenivalues to the resulting data frame (as an attribute of theyivariable), so, if possible, this information is passed on toregtest.rma() - added switch so that
regtest()can also provide the full results from the fitted model (thanks to Michael Dewey for the suggestion) weights.rma.mh()now shows the weights in % as intended (thanks to Gavin Stewart for pointing out this error)- more flexible handling of the
digitsargument in the various forest functions - forest functions now use
pretty()by default to set the x-axis tick locations (alimandatarguments can still be used for complete control) - studies that are considered to be 'influential' are now marked with an asterisk when printing the results returned by the
influence.rma.uni()function (see the documentation of this function for details on how such studies are identified) - added additional extractor functions for some of the influence measures (i.e.,
cooks.distance(),dfbetas()); unfortunately, thecovratio()anddffits()functions in thestatspackage are not generic; so, to avoid masking, there are currently no extractor functions for these measures - better handling of missing values in some unusual situations
- corrected small bug in
fsn()that would not allow the user to specify the standard errors instead of the sampling variances (thanks to Bernd Weiss for pointing this out) plot.infl.rma.uni()function now allows the user to specify which plots to draw (and the layout) and adds the option to show study labels on the x-axis- added proper
print()method for objects generated by theconfint.rma.uni(),confint.rma.mh(), andconfint.rma.peto()functions - when
transforatransfargument was a monotonically *decreasing* function, then confidence and prediction interval bounds were in reversed order; various functions now check for this and order the bounds correctly trimfill.rma.uni()now only prints information about the number of imputed studies when actually printing the model objectqqnorm.rma.uni(),qqnorm.rma.mh(), andqqnorm.rma.peto()functions now have a new argument calledlabel, which allows for labeling of points; the functions also now return (invisibly) the x and y coordinates of the points drawnrma.mh()withmeasure="RD"now computes the standard error of the estimated risk difference based on Sato, Greenland, & Robins (1989), which provides a consistent estimate under both large-stratum and sparse-data limiting models- the restricted maximum likelihood (REML) is now calculated using the full likelihood equation (without leaving out additive constants)
- the model deviance is now calculated as -2 times the difference between the model log-likelihood and the log-likelihood under the saturated model (this is a more appropriate definition of the deviance than just taking -2 times the model log-likelihood)
- naming scheme of illustrative datasets bundled with the package has been changed; now datasets are called
<dat.authoryear>; therefore, the datasets are now called (old name -> new name):dat.bcg -> dat.colditz1994dat.warfarin -> dat.hart1999dat.los -> dat.normand1999dat.co2 -> dat.curtis1998dat.empint -> dat.mcdaniel1994
- but
dat.bcghas been kept as an alias fordat.colditz1994, as it has been referenced under that name in some publications - added new dataset (
dat.pritz1997) to illustrate the meta-analysis of proportions (raw values and transformations thereof) - added new dataset (
dat.bonett2010) to illustrate the meta-analysis of Cronbach's alpha values (raw values and transformations thereof) - added new datasets (
dat.hackshaw1998,dat.raudenbush1985) - (approximate) standard error of the tau^2 estimate is now computed and shown for most of the (residual) heterogeneity estimators
- added
nobs()anddf.residual()methods for objects of classrma metafor.news()is now simply a wrapper fornews(package="metafor")- the package code is now byte-compiled, which yields some modest increases in execution speed
- some general code cleanup
- the
metaforpackage no longer depends on thenlmepackage - some improvements to the documentation
Version 1.6-0 (2011-04-13)
trimfill.rma()now returns a proper object even when the number of missing studies is estimated to be zero- added the (log transformed) ratio of means as a possible outcome measure to the
escalc()andrma.uni()functions - added new dataset (
dat.co2) to illustrate the use of the ratio of means outcome measure - some additional error checking in the various forest functions (especially when using the
ilab> - argument)
- in
labbe.rma(), the solid and dashed lines are now drawn behind (and not on top of) the points - slight change to
transf.ipft.hm()so that missing values intargs$niare ignored - some improvements to the documentation
Version 1.5-0 (2010-12-16)
- the
metaforpackage now has its own project website at: https://www.metafor-project.org - added
labbe()function to create L’Abbe plots - the
forest.default()andaddpoly.default()functions now allow the user to directly specify the lower and upper confidence interval bounds (this can be useful when the CI bounds have been calculated with other methods/functions) - added the incidence rate for a single group and for two groups (and transformations thereof) as possible outcome measures to the
escalc()andrma.uni()functions - added the incidence rate ratio as a possible outcome measure to the
rma.mh()function - added transformation functions related to incidence rates
- added the Freeman-Tukey double arcsine transformation and its inverse to the transformation functions
- added some additional error checking for out-of-range p-values in the
permutest.rma.uni()function - added some additional checking for out-of-range values in several transformation functions
- added
confint()methods forrma.mhandrma.petoobjects (only for completeness sake;printalready provides CIs) - added new datasets (
dat.warfarin,dat.los,dat.empint) - some improvements to the documentation
Version 1.4-0 (2010-07-30)
- a paper about the package has now been published in the Journal of Statistical Software (https://www.jstatsoft.org/v36/i03/)
- added citation info; see:
citation("metafor") metaforpackage now depends onnlmepackage- added extractor functions for the AIC, BIC, and deviance
- some updates to the documentation
Version 1.3-0 (2010-06-25)
metaforpackage now depends onFormulapackage- made
escalc()generic and implemented a default and a formula interface - added the (inverse) arcsine transformation to the set of transformation functions
Version 1.2-0 (2010-05-18)
- cases where k is very small (e.g., k equal to 1 or 2) are now handled more gracefully
- added sanity check for cases where all observed outcomes are equal to each other (this led to division by zero when using the Knapp & Hartung method)
- the "smarter way to set the number of iterations for permutation tests" (see notes for previous version below) now actually works like it is supposed to
- the
permutest.rma.uni()function now provides more sensible results when k is very small; the documentation for the function has also been updated with some notes about the use of permutations tests under those circumstances - made some general improvements to the various forest plot functions making them more flexible in particular when creating more complex displays; most importantly, added a
rowsargument and removed theaddrowsargument - some additional examples have been added to the help files for the
forestandaddpolyfunctions to demonstrate how to create more complex displays with these functions - added
showweightargument to theforest.default()andforest.rma()functions cumul()functions not showing all of the output columns when using fixed-effects models has been correctedweights.rma.uni()function now handlesNAs appropriatelyweights.rma.mh()andweights.rma.peto()functions addedlogLik.rma()function now behaves more like otherlogLik()functions (such aslogLik.lm()andlogLik.lme())
Version 1.1-0 (2010-04-28)
cint()generic removed and replaced withconfint()method forrma.uniobjects- slightly improved the code to set the x-axis title in the
forest()andfunnel()functions - added
coef()method for objects of classpermutest.rma.uni - added
appendargument toescalc()function - implemented a smarter way to set the number of iterations for permutation tests (i.e., the
permutest.rma.uni()function will now switch to an exact test if the number of iterations required for an exact test is actually smaller than the requested number of iterations for an approximate test) - changed the way how p-values for individual coefficients are calculated in
permutest.rma.uni()to 'two times the one-tailed area under the permutation distribution' (more consistent with the way we typically define two-tailed p-values) - added
retpermdistargument topermutest.rma.uni()to return the permutation distributions of the test statistics - slight improvements to the various transformation functions to cope better with some extreme cases
- p-values are now calculated in such a way that very small p-values stored in fitted model objects are no longer truncated to 0 (the printed results are still truncated depending on the number of digits specified)
- changed the default number of iterations for the ML, REML, and EB estimators from 50 to 100
Version 1.0-1 (2010-02-02)
- version jump in conjunction with the upcoming publication of a paper in the Journal of Statistical Software describing the package
- instead of specifying a model matrix, the user can now specify a model formula for the
modsargument in therma()function (e.g., like in thelm()function) permutest()function now allows exact permutation tests (but this is only feasible when k is not too large)forest()function now uses the level argument properly to adjust the CI level of the summary estimate for models without moderators (i.e., fixed- and random-effets models)forest()function can now also show the prediction interval as a dashed line for a random-effects model- information about the measure used is now passed on to the
forest()andfunnel()functions, which try to set an appropriate x-axis title accordingly funnel()function now has more arguments (e.g.,atransf,at) providing more control over the display of the x-axispredict()function now has its own print method and has a new argument (addx), which adds the values of the moderator variables to the returned object (whenaddx=TRUE)- functions now properly handle the na.action
"na.pass"(treated essentially like"na.exclude") - added method for
weights()function to extract the weights used when fitting models withrma.uni() - some small improvements to the documentation
Version 0.5-7 (2009-12-06)
- added
permutest()function for permutation tests - added
metafor.news()function to display theNEWSfile of themetaforpackage within R (based on the same idea in theanimatepackage by Yihui Xie) - added some checks for values below machine precision
- a bit of code reorganization (nothing that affects how the functions work)
Version 0.5-6 (2009-10-19)
- small changes to the computation of the DFFITS and DFBETAS values in the
influence()function, so that these statistics are more in line with their definitions in regular linear regression models - added option to the plot function for objects returned by
influence()to allow plotting the covariance ratios on a log scale (now the default) - slight adjustments to various
print()functions (to catch some errors when certain values wereNA) - added a control option to
rma()to adjust the step length of the Fisher scoring algorithm by a constant factor (this may be useful when the algorithm does not converge)
Version 0.5-5 (2009-10-08)
- added the phi coefficient (
measure="PHI"), Yule's Q ("YUQ"), and Yule's Y ("YUY") as additional measures to theescalc()function for 2x2 table data - forest plots now order the studies so that the first study is at the top of the plot and the last study at the bottom (the order can still be set with the
orderorsubsetargument) - added
cumul()function for cumulative meta-analyses (with a correspondingforest()method to plot the cumulative results) - added
leave1out()function for leave-one-out diagnostics - added option to
qqnorm.rma.uni()so that the user can choose whether to apply the Bonferroni correction to the bounds of the pseudo confidence envelope - some internal changes to the class and methods names
- some small corrections to the documentation
Version 0.5-4 (2009-09-18)
- corrected the
trimfill()function - improvements to various print functions
- added a
regtest()function for various regression tests of funnel plot asymmetry (e.g., Egger's regression test) - made
ranktest()generic and added a method for objects of classrmaso that the test can be carried out after fitting - added
anova()function for full vs reduced model comparisons via fit statistics and likelihood ratio tests - added the Orwin and Rosenberg approaches to
fsn() - added H^2 measure to the output for random-effects models
- in
escalc(),measure="COR"is now used for the (usual) raw correlation coefficient andmeasure="UCOR"for the bias corrected correlation coefficients - some small corrections to the documentation
Version 0.5-3 (2009-07-31)
- small changes to some of the examples
- added the log transformed proportion (
measure="PLN") as another measure to theescalc()function; changed"PL"to"PLO"for the logit (i.e., log odds) transformation for proportions
Version 0.5-2 (2009-07-06)
- added an option in
plot.infl.rma.uni()to open a new device for plotting the DFBETAS values - thanks to Jim Lemon, added a much better method of adjusting the size of the labels, annotations, and symbols in the
forest()function when the number of studies is large
Version 0.5-1 (2009-06-14)
- made some small changes to the documentation (some typos corrected, some confusing points clarified)
Version 0.5-0 (2009-06-05)
- first version released on CRAN
updates_old.txt · Last modified: by Wolfgang Viechtbauer