R/mean_plus_sds.R

Defines functions mean_plus_sds

Documented in mean_plus_sds

#' Mean plus \eqn{k} standard deviations
#'
#' @export
#' @param x numeric vector.
#' @param k number of standard deviations.
#' @return \code{mean(x) + k * sd(x)}
#'
mean_plus_sds <- function(x, k) {
  stopifnot(is.numeric(x))
  mean(x) + k * sd(x)
}
jgabry/RHhelpers documentation built on Feb. 22, 2024, 12:56 p.m.