summary.boxclip {boxfilter}R Documentation

Summarize boxclip results

Description

Summary method for class boxclip.

Usage

## S3 method for class 'boxclip'
summary(object,...)

Arguments

object

an object of class boxclip

...

currently, no other arguments are required.

Value

summary.boxclip prints the following items:

clipit

Cut-off value. Only points with a proportion >= clipit will be retained.

width

Rectangle width in x-units. Filter criterion is the proportion of data points inside the rectangle.

height

Rectangle height in y-units. Filter criterion is the proportion of data points inside the rectangle.

full

Number of original data.

remaining

Number of data remaining.

rest

Percentage remaining.

Author(s)

Thomas Ruf thomas.p.ruf@me.com

References

Signer (2010) <doi: 10.1111/j.2041-210X.2009.00010.x>

See Also

boxclip

Examples

data ("wb_month.RData")

x=wb_month$x
y=wb_month$hr

myclip=boxclip(x,y,clipit=0.25,width=15)
summary(myclip)

[Package boxfilter version 0.2 Index]