dfSummary: Dataframe Summary

Description

Summary of a dataframe consisting of: variable names and labels, factor levels, frequencies or numerical summary statistics, and valid/missing observations information.

Usage

dfSummary(x, round.digits=2, style="multiline", justify="left", plain.ascii=TRUE, file=NA, append=FALSE,  varnumbers=FALSE, display.labels=any(sapply(X = x, FUN = Hmisc::label) != ""), max.distinct.values=10, trim.strings=FALSE, max.string.width=15, split.cells=40, escape.pipe=FALSE, ...)

Arguments

A dataframe.

round.digits

Number of digits for rounding (used in numerical stats and in frequency tables).

style

The style to be used in pander table. Defaults to “multiline”. Alternatively, use “grid”. Style “simple” is not supported, and “rmarkdown” will fall back on “multiline”.

justify

pander argument. Defaults to “left”.

plain.ascii

pander argument; when results are displayed in console, this avoids having markdown markup characters in the tables. Defaults to TRUE, so make sure to change it to FALSE in markdown documents.

file

The text file to be written to disk. Defaults to NA.

append

When “file” argument is supplied, this indicates whether to append output to existing file (TRUE) or to overwrite any existing file (FALSE, default). If TRUE and no file exists, a new file will be created.

varnumbers

Should a column with column number be included? Defaults to FALSE.

display.labels

If TRUE, variable labels (as defined with rapportools or Hmisc's label function) will be displayed. By default, labels are shown if any column has a defined label.

max.distinct.values

The maximum number of items to be displayed in the frequency cell. If variable has more distinct values, no frequency will be shown (only a message stating the number of distinct values).

trim.strings

For character variables, remove any white space at the beginning or end of the string. This will impact the frequencies so interpret the frequencies cell accordingly. Defaults to FALSE.

max.string.width

Limits the number of characters to display in the frequency tables. Defaults to 15.

split.cells

pander argument. Number of characters allowed on a line before splitting the cell. Defaults to 40.

escape.pipe

Only useful when style='grid' and file argument is not NA, in which case it will escape the pipe character (|) to allow Pandoc to correctly convert multiline cells.

...

Additional arguments passed to pander.

Value

x.

References

https://github.com/dcomtois/summarytools

Examples

Run this code

  ## Not run: view(dfSummary(iris))
  data(tobacco)
  dfSummary(tobacco)