Generates a set of Cauchy distributed values.

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

set_n(5) r_cauchy(10)
#> [1] 10.259588 8.125346 6.986990 8.139630 11.682659
r_cauchy(1:10)
#> [1] 0.9354268 0.7532907 2.5770374 3.9474360 5.8196961 4.2407836 9.7657158 #> [8] 8.1457319 6.4009626 6.8713938
r_cauchy(10, 2)
#> [1] 16.638409 9.046009 -25.968454 9.869713 10.107015
r_cauchy(10, 2, n = 10)
#> [1] 6.700287 14.672785 9.473142 6.803808 6.497526 8.074509 #> [7] -4.771566 11.869725 -61.563382 17.520560