is_outlier: Flag Outliers

View source: R/is_outlier.R

is_outlierR Documentation

Flag Outliers

Description

By default the function returns a logical vector that indicates which observations were identified or declared as (potential) outliers by the method; if names = TRUE is set in the function call, the row names of the (potential) outliers are returned.

Usage

is_outlier(object, ...)
## S3 method for class 'wbaconmv'
is_outlier(object, names = FALSE, ...)
## S3 method for class 'wbaconlm'
is_outlier(object, names = FALSE, ...)

Arguments

object

object of class wbaconmv or wbaconlm.

names

[logical], if TRUE (default), a vector is returned that identifies the (potential) outliers; otherwise, the row names of the outliers are returned.

...

additional arguments passed to the method.

Value

A logical vector or vector with row names.

See Also

wBACON_reg and wBACON

Examples

data(swiss)
m <- wBACON(swiss)

# indicator vector of potential outliers
is_outlier(m)

# names of the potential outliers
is_outlier(m, names = TRUE)



wbacon documentation built on June 8, 2025, 10:07 a.m.