R/z_score.R

In aedobbyn/dobtools: dobtools

#' Z-Score a vector
#'
#' Scale a vector and get a plain vanilla numeric vector back.
#' @param vec A numeric vector
#' @keywords scale
#' @export
#' @examples
#'
#' z_score(mtcars$mpg)

z_score <- function(vec) {
  vec_mean <- mean(vec, na.rm = TRUE)
  vec_sd <- stats::sd(vec, na.rm = TRUE)

  get_score <- function(e) {
    z <- (e - vec_mean) / vec_sd
  }

  vec_z <- vec %>% purrr::map_dbl(get_score)
  return(vec_z)
}