R/RWeights.R

In EarthSystemDiagnostics/ecustools: A miscellaneous collection of R functions for working with time-series and paleo data.

#' @title Draw random number between 1 and length(weights) with the distribution
#' @param n Number of random numbers to be drawn
#' @param weights vector of numbers; defines the distribution
#' @return vector of n random numbers between 1 and length(weights)
#' @author Thomas Laepple
#' @examples
#' weights <- c(rep(1,10), 1:10, 10:1)
#' hist(RWeights(100000, weights), breaks = 501)
#' @export
RWeights <- function(n = 1000, weights) {
  function_deprecated("stattools")
  base::sample.int(length(weights),
    n,
    prob = weights,
    replace = TRUE
  )
}