R/bootstrapSample.R

In jzemmels/statsfoRdummies: STAT 585 Final Project

#' @name bootstrapSample
#' @export bootstrapSample
#' @author Gulzina Kuttubekova
#'
#' @title Generate bootstrap samples
#'
#' @description Takes in dataset in a vector form. Returns a list of n bootstrap sample.
#'
#' @param n number of bootstrap samples to generate
#' @param s sample dataset in a vector form
#'
#' @return A list of n bootstrap samples
#'
#' @examples bootstrapSample(rnorm(30), 8)
#'
#' @importFrom plotly plot_ly layout animation_opts animation_slider animation_button
#' @importFrom dplyr %>%
#' @importFrom assertthat not_empty
#' @importFrom rlang is_scalar_integerish
#' @importFrom checkmate assert anyMissing

bootstrapSample <- function(s, n) {
  # assert that n is scalar, numeric, not NaN, NA, Inf or 0
  assert(
    is_scalar_integerish(n)
  )
  if (is.nan(n) || is.infinite(n) || n == 0) {
    stop("n can't be NaN, Inf or zero")
  }

  # assert that s is non-empty vector, does not contain Inf, NA or NaN
  assert(
    is.vector(s),
    not_empty(s),
    (!anyMissing(s)),
    (!anyInfinite(s)),
    combine = "and"
  )

  # constants
  m = length(s)

  # store bootstrap samples in a list
  samples <- list()

  # create n bootstrap samples
  for (i in 1:n) {
    ss <- sample(s, m, replace = TRUE)
    samples[[i]] <- ss
  }

  # check if result is in the list form and return it
  assert(
    check_list(samples)
  )
  return(samples)
}