vsample: Wrapper for 'sample()' that always assumes input is a vector...

In jhrcook/jhcutils: Utility Functions for Joshua H. Cook

Description

The function base::sample() accepts either a vector of valuesto sample from, or a single numeric value that is turned into a vector from 1 to the input value and this range is sampled from. This has resulted in a rather frustrating (and perplexing) error for me in the past. This function, vsample() always assumes the input is a vector. Therefore, if the input vector is of length 1, that value is just returned (i.e. sampling 1 value from a vector of length 1 will always select the single element).

Usage

vsample(x, size = length(x), replace = FALSE, prob = NULL)

Arguments

x	either a vector of one or more elements from which to choose, or a positive integer. See ‘Details.’
size	a non-negative integer giving the number of items to choose.
replace	should sampling be with replacement?
prob	a vector of probability weights for obtaining the elements of the vector being sampled.

Value

For sample a vector of length size with elements drawn from either x

Examples

sample(10)
vsample(10)

vsample(10, size = 3, replace = TRUE)

sample(c(1, 2, 3))
vsample(c(1, 2, 3))

jhrcook/jhcutils documentation built on Sept. 2, 2020, 7:16 a.m.