summary_mod: Object Summaries Modified

In ravenroadresources/petroreadr: Read File Formats Used In The Oil Industry

Description

summary is a generic function used to produce result summaries of the results of various model fitting functions. The function invokes particular methods which depend on the class of the first argument.

Usage

summary_mod(object, ..., digits = max(3L, getOption("digits") - 3L))

Arguments

object	an object for which a summary is desired.
...	additional arguments affecting the summary produced.
digits	integer, used for number formatting with signif() (for summary.default) or format() (for summary.data.frame). In summary.default, if not specified (i.e., missing(.)), signif() will not be called anymore (since R >= 3.4.0, where the default has been changed to only round in the print and format methods).

Value

The form of the value returned by summary depends on the class of its argument. See the documentation of the particular methods for details of what is produced by that method.

The default method returns an object of class c("summaryDefault", "table") which has specialized format and print methods. The factor method returns an integer vector.

The matrix and data frame methods return a matrix of class "table", obtained by applying summary to each column and collating the results.

Note

this function is a modification of the base::summary function to add: - p90 - p10 - st.dev

Examples

## Not run: 
summary(data, digits = 2)

## End(Not run)

ravenroadresources/petroreadr documentation built on May 23, 2019, 3:03 p.m.