getOutlierResults: Obtain outlier results

In kueckelj/confuns: Convenience Functions

Obtain outlier results

Description

Extracts outlier results from the object.

Usage

getOutlierResults(object, ...)

## S4 method for signature 'OutlierDetection'
getOutlierResults(object, method = "IQR", across = NULL, verbose = TRUE)

## S4 method for signature 'Analysis'
getOutlierResults(object, method = "IQR", across = NULL, verbose = TRUE)

Arguments

object	Any object for whose class a method has been defined.
method	Character value. The outlier detection method. Valid input options are 'IQR' and 'Mahalanobis'.
across	Character value or NULL. If character, denotes the grouping variable of interest.
verbose	Logical. If set to TRUE informative messages regarding the computational progress will be printed. (Warning messages will always be printed.)

Value

The return value depends on the method chosen:

• method = 'IQR': A named list in which each slot is a vector of IDs which were identified as outliers within a numeric variable denoted by the name of the list's slot.

• method = 'Mahalanobis': A data.frame with column names <key.name>, mahal and pval.

If across is a character value the returned value is a list named according to the groups of the grouping variable across each containing output as described above.

kueckelj/confuns documentation built on July 4, 2024, 4:53 p.m.