outliers: Extracts Outliers

View source: R/methods.R

outliersR Documentation

Extracts Outliers

Description

Extracts outliers from object of class "outForest". The outliers are sorted by their absolute score in descending fashion.

Usage

outliers(object, ...)

## Default S3 method:
outliers(object, ...)

## S3 method for class 'outForest'
outliers(object, ...)

Arguments

object

An object of class "outForest".

...

Arguments passed from or to other methods.

Value

A data.frame with one row per outlier. The columns are as follows:

  • row, col: Row and column in original data with outlier.

  • observed: Observed value.

  • predicted: Predicted value.

  • rmse: Scaling factor used to normalize the difference between observed and predicted.

  • score: Outlier score defined as (observed-predicted)/RMSE.

  • threshold: Threshold above which an outlier score counts as outlier.

  • replacement: Value used to replace observed value.

Methods (by class)

  • outliers(default): Default method not implemented yet.

  • outliers(outForest): Extract outliers from outForest object.

Examples

x <- outForest(iris)
outliers(x)

outForest documentation built on May 31, 2023, 5:55 p.m.