msummary: Modified summaries

In mosaicCore: Common Utilities for Other MOSAIC-Family Packages

Modified summaries

Description

msummary provides modified summary objects that typically produce output that is either identical to or somewhat terser than their summary() analogs. The contents of the object itself are unchanged (except for an augmented class) so that other downstream functions should work as before.

Usage

## S3 method for class 'msummary.lm'
print(
  x,
  digits = max(3L, getOption("digits") - 3L),
  symbolic.cor = x$symbolic.cor,
  signif.stars = getOption("show.signif.stars"),
  ...
)

## S3 method for class 'msummary.glm'
print(
  x,
  digits = max(3L, getOption("digits") - 3L),
  symbolic.cor = x$symbolic.cor,
  signif.stars = getOption("show.signif.stars"),
  ...
)

msummary(object, ...)

## Default S3 method:
msummary(object, ...)

## S3 method for class 'lm'
msummary(object, ...)

## S3 method for class 'glm'
msummary(object, ...)

Arguments

x	an object to summarize
digits	desired number of digits to display
symbolic.cor	see summary()
signif.stars	a logical indicating whether to display stars to indicate significance
...	additional arguments
object	an object to summarise

Examples

msummary(lm(Sepal.Length ~ Species, data = iris))

mosaicCore documentation built on Nov. 5, 2023, 9:06 a.m.