getOutlierResults: Obtain outlier detection results

In theMILOlab/cypro: A Toolbox for Analysis of Single Cell Microscopy Data

Obtain outlier detection results

Description

These functions can be used to extract the results of the outlier detection algorithms.

Usage

getOutlierResults(
  object,
  method_outlier = NULL,
  check = TRUE,
  phase = NULL,
  verbose = NULL
)

getOutlierIds(
  object,
  method_outlier = NULL,
  check = FALSE,
  flatten = TRUE,
  phase = NULL
)

Arguments

object	A valid cypro object.
method_outlier	Character vector. Specifies the method/algorithm of interest. Use validOutlierDetectionMethods() to obtain all valid input options.
phase	Character or numeric. If character, the ordinal value referring to the phase of interest (e.g. 'first', 'second' etc.). referring to the phase of interest or 'all'. If numeric, the number referring to the phase. If set to NULL takes the phase denoted as default with adjustDefault(). Ignored if the experiment design contains only one phase.
verbose	Logical. If set to TRUE informative messages regarding the computational progress will be printed. (Warning messages will always be printed.)

Value

getOutlierResults() returns a list in which each slot contains the results for a specific method. getOutlierIds() returns a character vector of cell ids containing all cell ids that have been detected as outliers by at least one method.

theMILOlab/cypro documentation built on April 5, 2022, 2:03 a.m.