RSurvey (version 0.6-0)

SummarizeData: Summarize Object

Description

A summary of the descriptive statistics of an array object.

Usage

SummarizeData(obj, digits = NULL, units = NULL)

Arguments

obj

an array object for which the summary is desired.

digits

integer; the decimal precision of the object (only pertains to objects of class dQuote{numeric}).

units

integer; the date and time format, its default is %Y-%m-%d %H:%M:%S.

Value

• Results are dependent on the class of obj. Returns a list with the following components:
• Count
  integer; array length.
• NAs
  integer; number of NA values.
• Class
  character; the objects class attribute.
• Min., Max.
  numeric; extreme values with NA values ignored.
• 1st Qu., Median, 3rd Qu.
  numeric; estimates of the underlying distribution quantiles with NA values ignored.
• Mean
  numeric; arithmetic mean with NA values ignored.
• St.Dev.
  numeric; standard deviation with NA values ignored.
• Sum
  numeric; sum with NA values ignored.
• Hist
  histogram; an object of class histogram, see hist documentation for details.
• Unique
  integer; number of unique factors.
• TRUE, FALSE
  integer; number of TRUE and FALSE values, respectively.
• String
  character; a formatted text summary of the descriptive statistics.
• Time Per.
  character; a formatted time duration.

See Also

quantile, hist

Examples

summary(attenu$dist, digits = 4)
SummarizeData(attenu$dist, digits = 4)