summary_optbin: Summarizing Optimal Bins

summary.optbinR Documentation

Summarizing Optimal Bins

Description

summary method for class optbin.

Usage

## S3 method for class 'optbin'
summary(object, show.range=FALSE, ...)

Arguments

object

an object of class optbin

show.range

if true then print the bin's range of points (endpoint inclusive) in the sorted data

...

generic arguments (ignored)

Details

Prints a table with the upper threshold (inclusive), the average of the data within the bin, and the (mean) squared error sum. show.range also adds a column with the start and end indices of the sorted data belonging to the bin, although this applies to the sorted list and is less useful in general.

Value

Only called for side-effects (printing). There is no return value.

See Also

optbin, print.optbin


optbin documentation built on Sept. 20, 2022, 1:06 a.m.