R/oneSampleZ.R

In JoWatson2011/mypackage: R forwards tutotrial

#' Calculate One Sample Z-Score
#'
#' @param v a numerical vector
#' @param u the hypothesised mean
#'
#' @return a number
#' @importFrom stats sd
#' @export
#'
#' @examples
#' oneSampleZ(rnorm(50),50)
oneSampleZ <- function(v, u){
  mean(v) - u/(sd(v)/ sqrt(length(v)))
}