R/shuffle.R

In jakobbossek/re: Utility Functions Missing in Base R

#' @title
#' Random shuffle of a vector
#'
#' @description
#' Basically an alias for \code{\link[base]{sample}}
#' Note that if the \code{x} is a scalar value the function returns
#' simply the value itself, i.e. acts like the identity function.
#'
#' @param x [\code{vector}]\cr
#'   Input vector.
#' @return Shuffled/scrambled \code{x}.
#' @export
#' @examples
#' shuffle(1:10)
shuffle = function(x) {
  sample2(x, size = length(x))
}