rando (version 0.2.0)

r_cauchy: Generate Cauchy Distributed Values

Description

Generates a set of Cauchy distributed values.

Usage

r_cauchy(
  location = 0,
  scale = 1,
  ...,
  n = default_n(location, scale),
  .seed = NULL
)

Arguments

location

vector of locations

scale

vector of scales, strictly positive

...

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

# NOT RUN {
set_n(5)

r_cauchy(10)

r_cauchy(1:10)

r_cauchy(10, 2)

r_cauchy(10, 2, n = 10)
# }