methods: S3 methods for 'inDep'

In AssocBin: Measuring Association with Recursive Binning

S3 methods for 'inDep'

Description

The 'summary' and 'plot' methods outlined here support the quick description of an 'inDep' object.

Usage

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

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

Arguments

object	'inDep' object to summarize
...	additional arguments to pass on to the method
x	object with class 'inDep'
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

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 'inDep' object.

Value

Nothing for the plot method, while summary quietly returns a summary of 'inDep'

Functions

• summary(inDep): Summary method for 'inDep'

• plot(inDep): Plot method for 'inDep'

Author(s)

Chris Salahub

AssocBin documentation built on April 3, 2025, 7:46 p.m.