super_summary: Enhanced Object Summaries

In TomKellyGenetics/tktools: Package of personal utilities

Enhanced Object Summaries

Description

super_summary is a generic function used to produce result summaries of the results of various model fitting functions. The function invokes particular methods which depend on the class of the first argument.

This version adds addition features for convenient interpretation with all-in-one super_summary statistics.

Usage

super_summary(object, ...)

## Default S3 method:
super_summary(object, ..., digits, quantile.type = 7)
## S3 method for class 'data.frame'
super_summary(object, maxsum = 7,
        digits = max(3, getOption("digits")-3), ...)

## S3 method for class 'factor'
super_summary(object, maxsum = 100, ...)

## S3 method for class 'matrix'
super_summary(object, ...)

## S3 method for class 'summaryDefault'
format(x, digits = max(3L, getOption("digits") - 3L), ...)
## S3 method for class 'summaryDefault'
print(x, digits = max(3L, getOption("digits") - 3L), ...)

Arguments

x	a result of the default method of super_summary().
...	additional arguments affecting the super_summary produced.
object	an object for which a super_summary is desired.
maxsum	integer, indicating how many levels should be shown for factors.
digits	integer, used for number formatting with signif() (for super_summary.default) or format() (for super_summary.data.frame). In super_summary.default, if not specified (i.e., missing(.)), signif() will not be called anymore (since R >= 3.4.0, where the default has been changed to only round in the print and format methods).
quantile.type	integer code used in quantile(*, type=quantile.type) for the default method.

Details

For factors, the frequency of the first maxsum - 1 most frequent levels is shown, and the less frequent levels are summarized in "(Others)" (resulting in at most maxsum frequencies). The functions super_summary.lm and super_summary.glm are examples of particular methods which summarize the results produced by lm and glm.

Value

The form of the value returned by super_summary depends on the class of its argument. See the documentation of the particular methods for details of what is produced by that method.

The default method returns an object of class c("summaryDefault", "table") which has specialized format and print methods. The factor method returns an integer vector.

The matrix and data frame methods return a matrix of class "table", obtained by applying super_summary to each column and collating the results.

References

Chambers, J. M. and Hastie, T. J. (1992) Statistical Models in S. Wadsworth & Brooks/Cole.

See Also

[anova()] [summary()] [summary.glm()] [summary.lm()] [sd()] [summary.glm()]

Examples

super_summary(attenu, digits = 4) #-> super_summary.data.frame(...), default precision

super_summary(attenu $ station, maxsum = 20) #-> super_summary.factor(...)

TomKellyGenetics/tktools documentation built on July 6, 2024, 5:44 a.m.