R/outlier.R

In iml-assess/catchR: Analyse catch data and get catch-at-age matrices

##' Identify outliers based on the interquantile range
##' @param x vector
##' @param coef multiplication factor
##' @details Identifies outliers based on common rule of coef * the interquantile range. The default coefficient is set to 1.5. A coefficient of 3 is recommended for extremes.  Returns a vector of true or false.
##' @rdname outlier
##' @export
outlier <- function(x, coef=1.5, na.rm = TRUE, ...) {
    qnt <- quantile(x, probs=c(.25, .75), na.rm = na.rm, ...)
    H <- coef * IQR(x, na.rm = na.rm)
    x < (qnt[1] - H) |x > (qnt[2] + H)
}