outliers: Outliers accessors for 'seahorse' S4 objects

outliersR Documentation

Outliers accessors for seahorse S4 objects

Description

Outlier wells may be excluded from analyses. They are identified using the findOut method.

Usage

## S4 method for signature 'Seahorse'
outliers(x)

## S4 replacement method for signature 'Seahorse'
outliers(x, action = c("remove", "reset", "replace", "add", "subtract")) <- value

Arguments

x

A Seahorse or Herd object.

action

Indicates how replacement values modify the existing values:

action     description
remove     set all values to NA
reset     assign outliers based on findOut
replace     completely replace outliers with new values
add     add new outlier wells
subtract     remove outlier wells
value

A data frame with two columns named rate and well. The rate columns should contain either OCR or ECAR. The well column identifies the outlier wells formatted as "A01". For the "reset" and "remove" actions, the assigned value is ignored, but use NA.

Value

outliers(x) returns a data frame of wells identified as outliers for OCR and ECAR calculations and plots.

See Also

findOut

Examples

outliers(sheldon)
outliers(sheldon, "replace") <- findOut(sheldon)
outliers(sheldon)
outliers(sheldon, "reset") <- NA
outliers(sheldon)


wmoldham/seahorse documentation built on June 9, 2025, 11:36 a.m.