Deprecations

Removed tidiers for objects from the orcutt package as it was archived from CRAN 4 months prior to the package release.

Minor Improvements

tidy.coeftest now returns non-NA values for conf.low and conf.high for a model fitted with only a constant term and cluster robust std errors computed using vcovCL from sandwich (#1227).
Added support for new column name in lme4 ANOVA output. (lme4 tidiers are technically supplied by broom.mixed, but intermediate output is routed through broom's tidy.anova() method) (#1239).

Miscellaneous

Various improvements to infrastructure and testing:
- Migrated all messages, warnings, and errors to use the cli package (#1230).
- Aligned names of source and test files (#1229).
- Transitioned to the third edition of testthat (#1228).

- R
Published by simonpcouch about 1 year ago

broom - broom 1.0.7

Corrected nobs entries in glance.coxph() output: the package used to return length(object$linear.predictors) (equal to n rather than nevent) and now uses survival's method (#1224).
Corrected confidence interval values in tidy.boot() and addressed errors when bootstrapping confidence intervals for multiple terms (#1212).
Reverted deprecation of tidiers for objects from the margins package now that the package is back on CRAN (#1220).
Addressed failure in tidy.anova() ahead of upcoming car release (#1215).
Clarified documentation for a number of cases where dots were documented as unused but actually passed to internal functions (#1214).
Addressed error in augment.betareg() and augment.betamfx() with data = NULL and non-null newdata (#1216, #1218).
glance.lm() now returns non-NA values for statistic, p.value, and df for models fitted with a single predictor and no intercept (@jrob95, #1209).

- R
Published by simonpcouch over 1 year ago

New Features

Added support for conf.level in augment.lm() (#1191 by @zietzm).
Added support for columns adj.r.squared and npar in glance() method for objects outputted from mgcv::gam() (#1172).

Deprecations

Soft-deprecated tidiers for margins objects, as the package was archived from CRAN in April 2024. In the case that the package is back on CRAN before the next package release, broom will once again Suggest and test support for the package (#1200).
Moved forward with deprecation of tidiers for objects from the sp package. See resources linked in tidymodels/broom#1142 for more information on migration from retiring spatial packages.

Bug Fixes

While this broom release contains no changes to the tidy.survfit() method for objects from the survival package, the package has bumped the minimum required version for survival. Before survival 3.6-4, tidy.survfit() propagated "inconsistent" n.censor values from survival for multi-state models (#1195).
Corrected confidence interval values for precision components in tidy.betareg() output (#1169).
Fixed bug in tidier for car::linearHypothesis() output with long formulas (#1171).
Corrected coefficient values in tidy.varest() output (#1174).

- R
Published by simonpcouch about 2 years ago

broom - broom 1.0.5

tidy.coxph() will now pass its ellipses ... to summary() internally (#1151 by @ste-tuf).
Transitioned the deprecation of the region argument to tidy.SpatialPolygonsDataFrame from a warn- to a hard-deprecation (#1142).
Removed maptools and rgeos as Suggested packages ahead of their retirement. sp tidiers will be removed from a future release of the package (#1142).
Addressed bug in mlogit tidiers where augment.mlogit() would fail if supplied a model fitted with a non-default dfidx() (#1156 by @gregmacfarlane).
Addressed bug in ANOVA tidiers where tidy.anova() would fail if passed a model with many predictors (#1159 by @jwilliman).
Addressed warnings in ANOVA tidiers for unrecognized column names Resid..Df, Resid..Dev, and Deviance; those columns will be renamed df.residual, residual.deviance, and deviance, respectively (#1159 by @jwilliman).

- R
Published by simonpcouch almost 3 years ago

broom - broom 1.0.4

Added an intercept argument to tidy.aov(), a logical indicating whether to include information on the intercept as the first row of results (#1144 by @victor-vscn).
Moved forward with soft-deprecation of tidiers for objects from the sp package ahead of the retirement of the rgeos and maptools packages later this year. sp tidiers will be removed from a future release of the package (#1142).
Fixed bug in augment.glm() where the .std.resid column always contained standardized deviance residuals regardless of the value passed to the type.residuals argument (#1147).

- R
Published by simonpcouch about 3 years ago

broom - broom 1.0.3

Addressed test failures on R-devel.
Fixed bug in tidy.multinom() where the conf.level argument would be ignored.

- R
Published by simonpcouch over 3 years ago

broom - broom 1.0.2

Fixed a bug where augment() results would not include residuals when the response term included a function call (#1121, #946, #937, #124).
The default data argument for augment.coxph() and augment.survreg() has been transitioned from NULL to model.frame(x) (#1126 by @capnrefsmmat).
Migrated 'ggplot2' from strong to weak dependency, i.e. moved from Imports to Suggests.

- R
Published by simonpcouch over 3 years ago

broom - broom 1.0.1

Improves performance of tidy.lm() and tidy.glm() for full-rank fits (#1112 by @capnrefsmmat). In some contexts, execution time is halved. With broom 1.0.0:

``` r library(broom)

system.time( replicate(1000, tidy(lm(dist ~ speed, data = cars))) )

> user system elapsed

> 1.385 0.010 1.396

```

With this release:

``` r system.time( replicate(1000, tidy(lm(dist ~ speed, data = cars))) )

> user system elapsed

> 0.626 0.011 0.638

```

^{Created on 2022-08-30 by the reprex package (v2.0.1)}

Moves forward with deprecation of tidiers for sparse matrices outputted from the Matrix package, initially soft-deprecated in broom 0.5.0. The Matrix tidiers were light wrappers around coercion methods that will now be deprecated from Matrix itself in the upcoming 1.4-2 release. The affected methods are tidy.sparseMatrix(), tidy.dgCMatrix(), and tidy.dgTMatrix(). Note that tidy.confusionMatrix(), for relevant objects outputted from the caret package, is unaffected (#1113).
tidy.anova() works again with anova objects from the lme4 package (broken by addition of the terms column in the previous release)

- R
Published by simonpcouch almost 4 years ago

broom - broom 1.0.0

broom 1.0.0 is the first "production" release of the package, and includes a number of notable changes to both functionality and governance.

As of this release, the broom team will be following a set of guidelines that clarify the scope of further development on the package. Given the package's wide use and long history, these guidelines prioritize backward compatibility over internal consistency and completeness. You can read those guidelines here!

We've also made notable changes to error handling in this release:

Adds minimal ellipsis checking to warn on commonly misspecified arguments passed through ellipses. Notably:
- tidy() methods will now warn when supplied an exponentiate argument if it will be ignored.
- augment() methods will now warn when supplied a newdata argument if it will be ignored.
The warning regarding tidiers only maintained via dispatch to lm and glm is now displayed only once per session, per unique dispatch. That is, if a class_a object is tidied using a (g)lm method, broom will not warn when tidying class_a objects for the rest of the session, but if a class_b object is tidied using a (g)lm method in the same session, broom will warn again (#1101).

Other fixes and improvements:

Add exponentiate argument to tidy.boot() (#1039).
Update in tidy.htest() converting matrix-columns to vector-columns (#1081).
Address failures in tidy.glht() with conf.int = TRUE (#1103).
Address failures in tidy.zoo() when input data does not have colnames (#1080).
Transition tidiers for bivariate linear or spline-based interpolation---using list tidiers to interface with objects from the akima package is now considered off-label. See the interp package for a FOSS alternative.
Address failures in tidy.svyolr() when p.values = TRUE. Instead of aliasing tidy.polr() directly, tidy.svyolr() lightly wraps that method and warns if p.values is supplied (#1107).
Adds a term column and introduces support for car::lht() output in tidy.anova() (#1106 by @grantmcdermott).
Adds a dedicated glance.anova method (which previously dispatched to the
deprecated glance.data.frame() tidier, #1106 by @grantmcdermott).

As always, thanks to the broom community for their contributions and feedback! 🧹

- R
Published by simonpcouch almost 4 years ago

broom - broom 0.8.0

This update makes significant improvements to documentation, fixes a number of bugs, and brings the development flow of the package up to date with other packages in the tidymodels.

In the big picture, this release:

Makes many improvements to documentation:
- All tidiers now have example code demonstrating usage in their documentation. Tidiers for base packages as well as selected others also include sample code for visualization of results with ggplot2.
- Code examples in the documentation largely now follow consistent style---these changes were made largely to reflect the tidyverse style guide, addressing spacing, object naming, and commenting, among other things.
- Examples previously marked with \dontrun or \donttest have been workshopped to run reliably.
Clarifies errors and warnings for deprecated and un-maintained tidiers.
Ensures that tidiers are placed in files named according to the model-supplying package rather than the model object class for easier navigability of the source code.

Bug fixes and other improvements

Fix glance.fixest error when model includes only fixed effects and no regressors (#1018 by @arcruz0, #1088 by @vincentarelbundock).
Address excessive messaging from tidy.speedlm (#1084 by @cgoo4, #1087 by @vincentarelbundock).
Add nobs column to the output of glance.svyglm (#1085 by @fschaffner, #1086 by @vincentarelbundock).
Ensure tidy.prcomp description entries use consistent punctuation (#1072 by @PursuitOfDataScience).
Address breaking changes in glance.fixest and tidy.btergm.
Simplify handling of MASS::polr output in the corresponding tidy and augment methods.
Align continuous integration with current standards in tidymodels packages.

- R
Published by simonpcouch about 4 years ago

broom - broom 0.7.11

Addressed issue with the ordering of original observations in augment.rqs. Now function preserves the original data.frame names also when the input data.frame only has one column (#1052 by @ilapros).
Addressed warning from tidy.rma when x$ddf has length greater than 1 (#1064 by @wviechtb).
Fix errors in glance.lavaan in anticipation of upcoming tidyr release (#1067 by @DavisVaughan).
Corrected the confidence interval in tidy.crr(). The tidy.crr(conf.level=) argument was previously ignored (#1068 by @ddsjoberg).

- R
Published by simonpcouch over 4 years ago

broom - broom 0.7.10

Clarifies error when pysch::mediate output is dispatched to tidy.mediate (#1037 by @LukasWallrich).
Allows user to specify confidence level for tidy.rma (#1041 by @TarenSanders)
Clarifies documentation related to usage of augment_columns(); most package users should use augment() in favor of augment_columns(). See ?augment_columns for more details.
Extends support for emmeans by fixing non-standard column names in case of asymptotically derived inferential statistics. (#1046 by @crsh)
Fixes use of index columns in augment.mlogit and adds .resid column to output. (#1045, #1053, #1055, and #1056 by @jamesrrae and @gregmacfarlane)
Correct column naming of standard error measures in glance.survfit().
Various bug fixes and improvements to documentation.

- R
Published by simonpcouch over 4 years ago

broom - broom 0.7.9

Fix confidence intervals in tidy.crr(), which were previously exponentiated when exponentiate = FALSE (#1023 by @leejasme)
Update ergm tidiers in anticipation of changes in later releases. (#1034 by @krivit)
Address breakages in lfe and Rchoice tidiers

- R
Published by simonpcouch almost 5 years ago

broom - broom 0.7.8

Fixed bug in glance.ergm related to handling of MCMC details.
Address breakages in unit tests for {fixest} tidiers.

- R
Published by simonpcouch almost 5 years ago

broom - broom 0.7.7

Fixed bug in tidy.epi.2by2 that resulted in errors with new version of epiR (#1028 by @nt-williams)
Added exponentiate argument to tidy.gam() tidier applicable for parametric terms (#1013 by @ddsjoberg)
Added exponentiate argument to tidy.negbin() tidier (#1011 by @ddsjoberg)
Fixed failures in spdep tidiers following breaking changes in the most recent release
Various bug fixes and improvements to documentation

- R
Published by simonpcouch almost 5 years ago

broom - broom 0.7.6

Fixed bug in augment tidiers resulting in .fitted and .se.fit array columns.
Fixed bug that made column y non-numeric after tidy_xyz (#973 by @jiho)
Added tidiers for MASS:glm.nb (#998 by @joshyam-k)
Fixed bug in tidy.fixest that sometimes prevented arguments like se from being used (#1001 by @karldw)
Fixed bug in tidy.fixest that resulted in errors when columns with name x are present (#1007 by @grantmcdermott)
Moved forward with planned deprecation of gamlss tidiers in favor of those provided in broom.mixed
Various bug fixes and improvements to documentation

- R
Published by simonpcouch about 5 years ago

broom - broom 0.7.5

Fixed bug in the nnet::multinom tidier in the case that the response variable has only two levels (#993 by @vincentarelbundock and @hughjonesd)
Small fixes in anticipation of the upcoming survival release
Various bug fixes and improvements to documentation

- R
Published by simonpcouch over 5 years ago

broom - broom 0.7.4

broom 0.7.4 introduces tidier support for a number of new model objects and improves functionality of many existing tidiers!

New Tidiers

Add tidiers for Rchoice objects (#961 by @vincentarelbundock and @Nateme16)
Add tidiers for objects produced by car::leveneTest (#968 by @vincentarelbundock and @mkirzon)
Add tidiers for objects produced by cmprsk::crr (#971 and #552 by @vincentarelbundock and @margarethannum)
Add an augment() method for gam objects (#975 and #645 by @vincentarelbundock)
Add tidiers for vars objects (#979 and #161 by @vincentarelbundock and @Diego-MX)

This release also restores tidiers for felm objects from the lfe package, which was recently unarchived from CRAN.

Improvements to existing tidiers

tidy.emmGrid can now return std.error and conf.* columns at the same time. (#962 by @vincentarelbundock and @jmbarbone)
tidy.garch can now produce confidence intervals (#964 by @vincentarelbundock and @IndrajeetPatil)
tidy.coxph can now report confidence intervals on models utilizing penalized/clustering terms (#966 by @vincentarelbundock and @matthieu-faron)
augment.lm now works when some regression weights are equal to zero (#965 by @vincentarelbundock and @vnijs)
tidy.coxph can now handle models utilizing penalized/clustering terms (#966 and #969 by @vincentarelbundock, @matthieu-faron, and @KZARCA)
Fix bug in tidy.speedglm on R 4.0.0+ (#974 by @uqzwang)
tidy.multinom works with matrix response (#977 and #666 by @vincentarelbundock and @atyre2)
Various bug fixes and improvements to documentation and errors.

- R
Published by simonpcouch over 5 years ago

broom - broom 0.7.3

In broom 0.7.0, we introduced an error for model objects that subclassed lm and relied on tidy.lm(), or similarly for tidy.glm(). Tidiers for these objects were supported unintentionally, and we worried that tidiers for these objects would silently report innaccurate results.

In hindsight, this change was unnecessarily abrupt. We've decided to roll back this change, instead providing the following warning before allowing such objects to fall back to the lm/glm tidier methods:

Tidiers for objects of class {subclass} are not maintained by the broom team, and are only supported through the {dispatched method} tidier method. Please be cautious in interpreting and reporting broom output."

In addition,

Restores tidiers for summary.lm objects (#953 by @grantmcdermott)
Deprecate tidiers for the lfe package, which was archived from CRAN.
Various bug fixes and improvements to documentation and errors.

- R
Published by simonpcouch over 5 years ago

broom - broom 0.7.2

In broom 0.7.0, we introduced an error for objects that subclassed lm and relied on tidy.lm(). We've transitioned this error to a warning.
Various bug fixes and improvements to documentation and errors.

- R
Published by simonpcouch over 5 years ago

broom - broom 0.7.1

While broom 0.7.1 is a minor release, it includes a number of exciting new features and bug fixes!

New tidiers

Add tidiers for margins objects. (#700 by @grantmcdermott)
Added tidier methods for mlogit objects (#887 by @gregmacfarlane)
Add glance.coeftest() method (#932 by @grantmcdermott)

Improvements to existing tidiers

One of the more major improvements in this release is the addition of the interval argument to some augment methods for confidence, prediction, and credible intervals. These columns will be consistently labeled .lower and .upper! (#908 by @grantmcdermott, #925 by @bwiernik)

In addition...

Extended the glance.aov() method to include an r.squared column!
glance.survfit() now passes ... to summary.survfit() to allow for adjustment of RMST and other measures (#880 by @vincentarelbundock)
Several unsupported model objects that subclass glm and lm now error more informatively.
A number of improvements to documentation throughout the package.

Bug fixes

Fixed newdata warning message in augment.*() output when the newdata didn't contain the response variable—augment methods no longer expect the response variable in the supplied newdata argument. (#897 by @rudeboybert)
Fixed a bug related to tidy.geeglm() not being sensitive to the exponentiate argument (#867)
Fixed augment.fixest() returning residuals in the .fitted column. The method also now takes a type.residuals argument and defaults to the same type.predict argument as the fixest predict() method. (#877 by @karldw)
Fix tidy.felm confidence interval bug. Replaces "robust" argument with "se.type". (#919 by @grantmcdermott; supersedes #818 by @kuriwaki)
Fix a bug in tidy.drc() where some term labels would result in the overwriting of entries in the curve column (#914)
Fixed bug related to univariate zoo series in tidy.zoo() (#916 by @WillemVervoort)
Fixed a bug related to tidy.prcomp() assigning the wrong PC labels from "loadings" and "scores" matrices (#910 by @tavareshugo)
Fixed tidy.polr() bug where p-values could only be returned if exponentiate = FALSE.

Deprecations

We followed through with the planned deprecation of character vector tidiers in this release. Other vector tidiers that were soft-deprecated in 0.7.0 will be fully deprecated in a later release.

- R
Published by simonpcouch over 5 years ago

broom - broom 0.7.0

broom 0.7.0 is a major release with a large number of new tidiers, improvements to internal consistency, and deprecations of functions and arguments. See the package NEWS for more information!

- R
Published by simonpcouch almost 6 years ago

broom - Broom 0.5.6

See NEWS

- R
Published by alexpghayes about 6 years ago

broom - Broom 0.5.4

See NEWS

- R
Published by alexpghayes over 6 years ago

broom - Broom 0.5.3

Minor updates to remain on CRAN after changes to matrix classing behavior in R 4.0.0

- R
Published by alexpghayes over 6 years ago

broom - Broom 0.5.2

Users should notice no differences from previous releases
Fixes failing CRAN checks
Rewrite of tidy.ergm() internals for ergm 3.10

- R
Published by alexpghayes about 7 years ago

broom - Broom 0.5.1

Minor update to re-export tidy(), glance() and augment() from the generics package.

- R
Published by alexpghayes over 7 years ago

broom - Broom 0.5.0

Details available at https://broom.tidyverse.org/news/. This commit is exactly the code in the CRAN 0.5.0 version of the package.

- R
Published by alexpghayes almost 8 years ago

broom - Version 0.4.0: Many new tidiers; fixed issues in ANOVA and lme4

Added tidiers for geeglm, nlrq, roc, boot, bgterm, kappa, binWidth, binDesign, rcorr, stanfit, rjags, gamlss, and mle2 objects.
Added tidy methods for lists, including u, d, v lists from svd, and x, y, z lists used by image and persp
Added quick argument to tidy.lm, tidy.nls, and tidy.biglm, to create a smaller and faster version of the output.
Changed rowwise_df_tidiers to allow the original data to be saved as a list column, then provided as a column name to augment. This required removing data from the augment S3 signature. Also added tests-rowwise.R
Fixed various issues in ANOVA output
Fixed various issues in lme4 output
Fixed issues in tests caused by dev version of ggplot2

- R
Published by dgrtwo over 10 years ago

broom - Version 0.3.7 Tidiers for biglm, coeftest, plm, power.htest, lme, and more

Added tidiers for "plm" (panel linear model) objects from the plm package.
Added tidy.coeftest for coeftest objects from the lmtest package.
Set up tidy.lm to work with "mlm" (multiple linear model) objects (those with multiple response columns).
Added tidy and glance for "biglm" and "bigglm" objects from the biglm package.
Fixed bug in tidy.coxph when one-row matrices are returned
Added tidy.power.htest
Added tidy and glance for summaryDefault objects
Added tidiers for "lme" (linear mixed effects models) from the nlme package
Added tidy and glance for multinom objects from the nnet package.

- R
Published by dgrtwo about 11 years ago