initiateOutlierDetection: Set up 'OutlierDetection' object

View source: R/S4-Outlier.R

initiateOutlierDetectionR Documentation

Set up OutlierDetection object

Description

Sets up an object of class OutlierDetection.

Usage

initiateOutlierDetection(
  data,
  key_name,
  key_prefix = NULL,
  lgl_to_group = TRUE,
  meta_names = character(0),
  verbose = TRUE
)

Arguments

data

A data.frame. (Rownames are dropped.)

verbose

Logical. If set to TRUE informative messages regarding the computational progress will be printed.

(Warning messages will always be printed.)

Details

If key_name is NULL the key variable is constructed as a combination of the input data.frames rownames and the string provided with key_prefix. If the the datas rownames are NULL or contain "" the rownumbers are used instead. The newly constructed key variable is named data_ids.

Value

An object of S4-class OutlierDetection.


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