getOutlierIds {SomaDataIO} | R Documentation |
Get Flagged Ids From MAD Outlier Map
Description
Return the IDs of flagged samples for objects of the outlier_map
class.
Samples are flagged based on the percent analytes (RFU columns) for a given
sample that were identified as outliers using the median absolute
deviation (MAD).
Usage
getOutlierIds(x, flags = 0.05, data = NULL, include = NULL)
Arguments
x |
An object of class:
|
flags |
Numeric in |
data |
Optional. The data originally used to create the map |
include |
Optional. Character vector of column name(s) in |
Value
A data.frame
of the indices (idx
) of flagged samples, along
with any additional variables as specified by include
.
Author(s)
Caleb Scheidel
See Also
Other Calc Map:
calcOutlierMap()
,
plot.Map()
Examples
# flagged outliers
# create a single sample outlier (12)
out_adat <- example_data
apts <- getAnalytes(out_adat)
out_adat[12, apts] <- out_adat[12, apts] * 10
om <- calcOutlierMap(out_adat)
getOutlierIds(om, out_adat, flags = 0.05, include = c("Sex", "Subarray"))