outlier_tukey: Tukey's test for outliers
In SuisunMarshBranch/wqptools: Outlier Detection Working Group Toolbox

Description Usage Arguments Details Value Examples

Perform Tukey's test for mild and extreme outliers.

outlier_tukey(
  x,
  mask = !is.na(x),
  threshold = c(1.5, 3),
  return.score = FALSE,
  ...
)

`x`	A vector of data.
`mask`	A logical vector that defines which values in `x` will used when computing statistics. Useful when a subset of quality-assured data is available. Default mask is non-`NA` Values.
`threshold`	A length-two vector identifying thresholds for "mild" and "extreme" outliers.
`return.score`	if `TRUE`, return the numeric outlier score. If `FALSE`, return an ordered factor classifying the observations as one of "not outlier" (1), "mild outlier" (2), or "extreme outlier" (3).
`...`	Arguments passed on to `stats::quantile`

the values of threshold identify the multiplier of the interquartile range used to identify mild and extreme outliers. typical values are 1.5 for "mild" outliers and 3.0 for "extreme" outliers.

A vector the same length as x containing numeric scores or ordered factors.

x = seq(0, 34, by = 0.25)*pi
noise = rnorm(length(x), mean = 1, sd = 3)
y = sin(x) + noise
mask = noise < 1

outlier_tukey(y)
outlier_tukey(y, mask)
outlier_tukey(y, mask, threshold = c(2, 5))
outlier_tukey(y, return.score = TRUE)