R/isBetween.R

In swfscMisc: Miscellaneous Functions for Southwest Fisheries Science Center

#' @title Between
#' @description Is a numeric value between two other values?
#' 
#' @param x vector of numeric values to check.
#' @param a,b numeric values describing range. 
#' @param include.ends logical. Should test include \code{a} and \code{b}? Is 
#'   test > and < or >= and <= ?
#' @param na.convert logical. If \code{TRUE} and result of test is \code{NA} 
#'   because either \code{x}, \code{a}, or \code{b} is \code{NA}, 
#'   return \code{FALSE}, otherwise return \code{NA}.
#'
#' @details Order of \code{a} and \code{b} does not matter. If \code{b} is 
#'   \code{NULL} the range will be taken from values in \code{a}.
#'
#' @author Eric Archer \email{eric.archer@@noaa.gov}
#' 
#' @export
#' 
isBetween <- function(x, a, b = NULL, include.ends = FALSE, na.convert = TRUE) {
  rng <- range(c(a, b))
  result <- if(!include.ends) {
    sapply(x, function(x.i) x.i > rng[1] & x.i < rng[2])
  } else {
    sapply(x, function(x.i) x.i >= rng[1] & x.i <= rng[2])
  }
  ifelse(is.na(result) & na.convert, FALSE, result)
}