diff --git a/R/broom-package.R b/R/broom-package.R index 534fb800f..15d02074b 100644 --- a/R/broom-package.R +++ b/R/broom-package.R @@ -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 @@ -20,8 +25,5 @@ #' @importFrom glue glue #' #' @import dplyr -#' -#' @docType package -#' @aliases broom broom-package -#' @keywords internal -"_PACKAGE" +## usethis namespace: end +NULL diff --git a/R/broom.R b/R/broom.R index 2d8f76c20..934f1f40e 100644 --- a/R/broom.R +++ b/R/broom.R @@ -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()] diff --git a/man/broom.Rd b/man/broom.Rd index 701f27e7d..68f466e0e 100644 --- a/man/broom.Rd +++ b/man/broom.Rd @@ -1,20 +1,11 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/broom-package.R, R/broom.R +% Please edit documentation in R/broom-package.R \docType{package} \name{broom} \alias{broom} -\alias{_PACKAGE} \alias{broom-package} -\title{Convert Statistical Objects into Tidy Tibbles} +\title{broom: Convert Statistical Objects into Tidy Tibbles} \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. - 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