summary.comparedf: The summary method for a 'comparedf' object

In mayoverse/arsenal: An Arsenal of 'R' Functions for Large-Scale Statistical Summaries

The summary method for a comparedf object

Description

Print a more detailed output of the comparedf object.

Usage

## S3 method for class 'comparedf'
summary(object, ..., show.attrs = FALSE)

## S3 method for class 'summary.comparedf'
print(x, ..., format = "pandoc")

Arguments

object	An object of class "comparedf", as made by the comparedf S3 method.
...	Other arguments passed to comparedf.control. In print, these are passed to kable.
show.attrs	Logical, denoting whether to show the actual attributes which are different. For (e.g.) factors with lots of levels, this can make the tables quite wide, so this feature is FALSE by default.
x	An object returned by the summary.comparedf function.
format	Passed to kable: the format for the table. The default here is "pandoc". To use the default in kable, pass NULL.

Value

An object of class "summary.comparedf" is returned.

See Also

comparedf, comparedf.control

mayoverse/arsenal documentation built on Aug. 20, 2024, 4:32 a.m.