Skip to content

Commit

Permalink
deduplicate package-level docs (#1184)
Browse files Browse the repository at this point in the history
  • Loading branch information
olivroy authored Dec 15, 2023
1 parent ab8c3f3 commit f4fc69d
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 39 deletions.
30 changes: 16 additions & 14 deletions R/broom-package.R
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
#' @title Convert Statistical Objects into Tidy Tibbles
# Custom package description for the package help file.
#' @name broom
#' @description Convert statistical analysis objects from R into tidy tibbles,
#' so that they can more easily be combined, reshaped and otherwise processed
#' with tools like dplyr, tidyr and ggplot2. The package provides three S3
#' generics: tidy, which summarizes a model's statistical findings such as
#' coefficients of a regression; augment, which adds columns to the original
#' data such as predictions, residuals and cluster assignments; and glance,
#' which provides a one-row summary of model-level statistics.
#'
#' @description
#' Convert statistical analysis objects from R into tidy tibbles,
#' so that they can more easily be combined, reshaped and otherwise processed
#' with tools like dplyr, tidyr and ggplot2. The package provides three S3
#' generics: tidy, which summarizes a model's statistical findings such as
#' coefficients of a regression; augment, which adds columns to the original
#' data such as predictions, residuals and cluster assignments; and glance,
#' which provides a one-row summary of model-level statistics.
#'
#' @keywords internal
"_PACKAGE"

## usethis namespace: start
#' @importFrom stats AIC BIC coef confint fitted logLik model.frame
#' @importFrom stats pnorm qnorm qt predict residuals setNames var
#' @importFrom stats quantile model.response terms na.pass na.omit
Expand All @@ -20,8 +25,5 @@
#' @importFrom glue glue
#'
#' @import dplyr
#'
#' @docType package
#' @aliases broom broom-package
#' @keywords internal
"_PACKAGE"
## usethis namespace: end
NULL
14 changes: 0 additions & 14 deletions R/broom.R
Original file line number Diff line number Diff line change
@@ -1,17 +1,3 @@
#' @title Convert Statistical Objects into Tidy Tibbles
#' @name broom
#' @description Convert statistical analysis objects from R into tidy tibbles,
#' so that they can more easily be combined, reshaped and otherwise processed
#' with tools like dplyr, tidyr and ggplot2. The package provides three S3
#' generics: tidy, which summarizes a model's statistical findings such as
#' coefficients of a regression; augment, which adds columns to the original
#' data such as predictions, residuals and cluster assignments; and glance,
#' which provides a one-row summary of model-level statistics.
#'
#' @docType package
#' @aliases broom broom-package
NULL

#' @importFrom generics augment
#' @export
#' @seealso [augment.lm()]
Expand Down
13 changes: 2 additions & 11 deletions man/broom.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f4fc69d

Please sign in to comment.