Summarize an Object - Generic Function

DESCRIPTION:
Provides a synopsis of an object.

This function is generic (see Methods); method functions can be written to handle specific classes of data. Classes which already have methods for this function include: aov, aovlist, data.frame, factor, gam, glm, lm, loess, mlm, ms, nls, ordered, terms, tree.


USAGE:
summary(object, ...)

REQUIRED ARGUMENTS:
object:
any object, including a fitted model object of various kinds, a data frame, or a factor.

OPTIONAL ARGUMENTS:
...:
some methods have additional arguments.

VALUE:
a summary object is returned---usually a list-like object whose elements describe the contents of the argument to summary(). For example, the method for lm objects produces an object of class "summary.lm" with components "residuals", "correlation", "cov.unscaled", "r.squared", and more. There is a print() method corresponding to each "summary." class, so typing summary(object) will not save the summary, but rather produce a nicely formatted table of a selection of the components in the summary object. Simpler summary methods may get away without a special class; e.g., the summary for factors is the value of a call to table().

DETAILS:
Takes any S-PLUS object and returns a list of elements that describe the object's contents.

SEE ALSO:
Methods .

EXAMPLES:
stackfit <- lm(fomula = stack.loss ~ stack.x) # create object

summary(stackfit)

# Gives the following output: Call: lm(formula = stack.loss ~ stack.x) Residuals: Min 1Q Median 3Q Max -7.238 -1.712 -0.4551 2.361 5.698

Coefficients: Value Std. Error t value Pr(>|t|) (Int.) -39.9197 11.8960 -3.3557 0.0038 Air Flow 0.7156 0.1349 5.3066 0.0001 Water Temp 1.2953 0.3680 3.5196 0.0026 Acid Conc. -0.1521 0.1563 -0.9733 0.3440

Residual standard error: 3.243 on 17 degrees of freedom Multiple R-Squared: 0.9136 F-statistic: 59.9 on 3 and 17 degrees of freedom, the p-value is 3.016e-009

Correlation of Coefficients: (Intercept) Air Flow Water Temp Air Flow 0.1793 Water Temp -0.1489 -0.7356 Acid Conc. -0.9016 -0.3389 0.0002