Learn R Programming

AssocBin (version 1.1-2)

summary.DepSearch: S3 methods for `DepSearch`

Description

The `summary` and `plot` methods outlined here support the quick description of an `DepSearch` object.

Usage

# S3 method for DepSearch
summary(object, ..., adjustP = FALSE)

# S3 method for DepSearch print(x, ...)

# S3 method for DepSearch plot( x, ..., which = 1:5, border = "black", buffer = 0.01, dropPoints = FALSE, colrng = c("steelblue", "white", "firebrick"), nbr = NA, pch = "." )

Value

Nothing for the plot method, while summary quietly returns a summary of `DepSearch`

Arguments

object

`DepSearch` object to summarize

...

additional arguments to pass on to the method

adjustP

logical: should the p-values be adjusted for multiple testing?

x

object with class `DepSearch`

which

indices of binnings to display from `x`, where binnings are ordered by increasing p-value

border

colour of borders to be drawn on the binnings

buffer

relative width of empty space separating categories

dropPoints

logical: should points be dropped for the plot of the binnings?

colrng

colour range to be passed to `residualFill` for plotting

nbr

number of breaks to be passed to `residualFill` for plotting

pch

point type passed to plot

Functions

  • summary(DepSearch): Summary method for `DepSearch`

  • print(DepSearch): Print method for `DepSearch`

  • plot(DepSearch): Plot method for `DepSearch`

Author

Chris Salahub

Details

Methods

For each index in `which`, this function produces a row of three plots. The first plot is the raw data, the second plot is the ranks of the data, and the final plot is the binning contained in the `DepSearch` object.