R/sample_data_frame.R

In kimisc: Kirill's Miscellaneous Functions

#' @title Random Samples and Permutations for Data Frames
#' @description This function takes a sample of the specified size
#'   from the rows of `x` using either with or without replacement.
#' @param x A data frame.
#' @param size A non-negative integer giving the number of items to choose.
#' @param replace Should sampling be with replacement?
#' @param prob A vector of probability weights for obtaining the rows of the
#'   data frame being sampled.
#' @return A data frame of the same shape as `x`.
#' @details This function internally calls [sample.int()].
#' @examples
#' set.seed(42)
#' sample.rows(
#'   data.frame(a = c(1, 2, 3), b = c(4, 5, 6), row.names = c("a", "b", "c")),
#'   10,
#'   replace = TRUE
#' )
#' @export
#' @family deprecated functions
#' @name sample.rows-deprecated
#' @keywords internal
sample.rows <- function(x, size, replace = FALSE, prob = NULL) {
  deprecate("dplyr::sample_n")
  stopifnot(is.data.frame(x))
  x.indexes <- sample.int(nrow(x), size, replace, prob)
  x[x.indexes, ]
}