R/stack_normalise.R

In yliu0320/cwdata: Communicating with Data Resource Pack

#' Normalise a vector of numbers to sum to 1
#'
#' @aliases stack_normalize
#'
#' @param x A vector of numbers
#'
#' @return The vector x normalised to proportions
#'
#' @examples
#' x <- c(10, 30, 40)
#' stack_normalize(x)
#' x <- c(75, 0, 5, 20, NA)
#' stack_normalise(x)
#' x <- c(NA, NA, 10)
#' stack_normalize(x)
#'
#' @export
stack_normalise <- function(x){
  x/sum(x,na.rm=TRUE)
}

#' @export
stack_normalize <- stack_normalise