Generates a set of Hypergeometric distributed values.

r_hyper(
  total,
  positives,
  num,
  ...,
  n = default_n(total, positives, num),
  .seed = NULL
)

Arguments

total

size of the population (e.g. number of balls)

positives

number of elements with the desirable feature (e.g number of black balls)

num

number of draws to make

...

Unused

n

number of observations to generate. The default_n() function will provide a default value within context

.seed

One of the following:

  • NULL (default) will not change the current seed. This is the usual case for generating random numbers.

  • A numeric value. This will be used to set the seed before generating the random numbers. This seed will be stored with the results.

  • TRUE. A random seed value will be generated and set as the seed before the results are generated. Again, this will be stored with the results.

To extract the random seed from a previously generated set of values, use pull_seed()

Value

A numeric vector of length n

Examples

set_n(5) r_hyper(10, 5, 5)
#> [1] 1 4 3 2 2
r_hyper(10:20, 10, 5)
#> [1] 5 5 3 4 5 3 2 2 3 3 2
r_hyper(10, 5, 5, n = 10)
#> [1] 3 1 3 3 2 3 3 2 3 4