R/hai-range-statistic.R

In healthyR.ai: The Machine Learning and AI Modeling Companion to 'healthyR'

#' Get the range statistic
#'
#' @author Steven P. Sandeson II, MPH
#'
#' @description Takes in a numeric vector and returns back the range of that
#' vector
#'
#' @details Takes in a numeric vector and returns the range of that vector using
#' the `diff` and `range` functions.
#'
#' @param .x A numeric vector
#'
#' @examples
#' hai_range_statistic(seq(1:10))
#'
#' @return
#' A single number, the range statistic
#'
#' @export
#'

hai_range_statistic <- function(.x) {

  # Tidyeval ----
  x_term <- .x

  if (!is.numeric(x_term)) {
    stop(call. = FALSE, ".x must be a numeric vector.")
  }

  range_statistic <- base::diff(base::range(x_term))

  return(range_statistic)
}