getOutlierIDs: Obtain outlier ids

In kueckelj/confuns: Convenience Functions

Obtain outlier ids

Description

Extracts IDs that identify the observations that were determined as outliers.

Usage

getOutlierIDs(object, ...)

## S4 method for signature 'OutlierDetectionIQR'
getOutlierIDs(
  object,
  variables = NULL,
  across = NULL,
  across_subset = NULL,
  flatten = FALSE,
  ...
)

## S4 method for signature 'OutlierDetection'
getOutlierIDs(
  object,
  method = "IQR",
  variables = NULL,
  across = NULL,
  across_subset = NULL,
  flatten = FALSE
)

## S4 method for signature 'Analysis'
getOutlierIDs(
  object,
  variables = NULL,
  across = NULL,
  across_subset = NULL,
  flatten = FALSE
)

Arguments

object	Any object for whose class a method has been defined.
variables	Character vector. Specifies the variables of interest. If set to NULL all valid variables of the input data.frame are considered (as long as the total number does not exceeds the limit). If there are more variables you are interested in than they are variables you are not interested in specify those that you are not interested in prefixed with an '-'. Variables prefixed that way are discarded and the remaining are kept.
across	Character value. Specifies the discrete variable in the data.frame across which the variables of interest are to be analyzed or displayed.
flatten	Logical value. If across is specified flatten can be set to TRUE in order to force the flatten teh list into a character vector of IDs.

Value

Character vector if across = NULL. List of character vectors if across is a character value.

kueckelj/confuns documentation built on June 28, 2024, 9:19 a.m.