R/is_scalar_in.R

In rccmisc: Miscellaneous R Functions for Swedish Regional Cancer Centers

#' Test if scalar is in intervall
#' 
#' @param x R object to be tested, most likely a numeric vector of length one 
#' (other formats are allowed but will always return \code{FALSE}).
#' @param left,right arguments passed to \code{\link[dplyr]{between}}
#' @return
#' \code{is.scalar_in01} returns \code{TRUE} if \code{x} is an atomic vector of 
#' length one and \code{0 <= as_numeric(x) <= 1}.
#' \code{is.scalar_in} return a function similair to \code{is.scalar_in01} but with 
#' specified boundaries.
#' @export
#' @name is.scalar_in
#' @examples
#' is.scalar_in01(.5) # TRUE
#' is.scalar_in01(5) # FALSE
#' is.scalar_in01(seq(0,1,.1)) # FALSE
#' 
#' is_scalar_in09 <- is.scalar_in(0,9)
#' is_scalar_in09(5) # TRUE
is.scalar_in  <- function(left, right){
  function(x){
    is_numeric(x) && 
    length(x) == 1 && 
    as_numeric(x) >= left && 
    as_numeric(x) <= right
  }
}

#' @export
#' @rdname is.scalar_in
is.scalar_in01 <- is.scalar_in(0, 1)