R/requal.R

In romatt/metplot: Plotting of meteorological data

#' Test rough equality
#'
#' @param values close are any number of floating values to testval
#' @param testval value to be tested
#' @param epsilon float value indicating how large difference between values is allowed to be
#'
#' @rdname requal
#'
#' @return
#' @export
#'
#' @examples
#' c(0.01,0.02,0.011)%==%0.01 equals TRUE FALSE  TRUE
#'
#' requal(c(0.01,0.02,0.011),0.01)
requal <- function(values,testval,epsilon=0.01) {

  out<-sapply(values, function(v) {
    if (v+epsilon>testval && v-epsilon<testval){
      return(TRUE)
    } else {
      return(FALSE)
    }})

  return(out)

}

#' Shorthand to test rough equality
#'
#' @rdname requal
#' @return
#' @export
`%==%`  <- function(values, testval) requal(values, testval)