summarise.df: Summary Dataframe

In ivanliu1989/RQuant: A collection of generic functions

Description

This function takes a data frame as an input, and provides a quick summary of the contents of the data frame.

For character fields or factors, it provides a frequency table, sorted decreasing, if there are relatively few distinct values. Otherwise, the first few values are shown.

For numeric fields, including date or datetime fields, it provides quartiles.

It also provides a pairs plots for the first few numeric fields.

Usage

summarise.df(df, filename = "output", round.date = TRUE, n.values = 10,
  n.print = 8, n.pairs = 12)

Arguments

df	The data frame to be summarised
filename	A character string to use as the name of the output files
round.date	A logical, whether to round datetime values to just date
n.values	Integer, the maximum number of distinct values to show for frequency tables. For fields with more than this number of distinct values, a frequency table will be displayed. For fields with less than this number of distinct values, the first few values will be displayed.
n.print	Integer, the number of sample values to display.
n.pairs	Integer, the number of numeric variables to display in the pairs plot.

Value

The function does not return any value. But it does produce a text file and a png file, based on the supplied filename stub.

See Also

str, summary.data.frame, head

Examples

summarise.df(mtcars)

ivanliu1989/RQuant documentation built on Sept. 13, 2019, 11:53 a.m.