/R/broom-package.R

https://github.com/tidymodels/broom · R · 30 lines · 1 code · 1 blank · 28 comment · 0 complexity · 135d78d33b693c6d1039a5e7eb015ee3 MD5 · raw file

  1. #' @title Convert Statistical Objects into Tidy Tibbles
  2. #' @name broom
  3. #' @description Convert statistical analysis objects from R into tidy tibbles,
  4. #' so that they can more easily be combined, reshaped and otherwise processed
  5. #' with tools like dplyr, tidyr and ggplot2. The package provides three S3
  6. #' generics: tidy, which summarizes a model's statistical findings such as
  7. #' coefficients of a regression; augment, which adds columns to the original
  8. #' data such as predictions, residuals and cluster assignments; and glance,
  9. #' which provides a one-row summary of model-level statistics.
  10. #'
  11. #' @importFrom stats AIC BIC coef confint fitted logLik model.frame
  12. #' @importFrom stats predict qnorm qt residuals setNames var na.omit
  13. #' @importFrom stats model.response terms na.pass cooks.distance
  14. #' @importFrom stats influence rstandard
  15. #'
  16. #' @importFrom purrr map_df set_names possibly
  17. #' @importFrom tibble tibble as_tibble
  18. #' @importFrom tidyr pivot_longer pivot_wider
  19. #' @importFrom dplyr select filter mutate mutate_at
  20. #'
  21. #' @importFrom utils head
  22. #' @importFrom glue glue
  23. #'
  24. #' @import dplyr
  25. #'
  26. #' @docType package
  27. #' @aliases broom broom-package
  28. #' @keywords internal
  29. "_PACKAGE"