dcauchy_rvec: The Cauchy Distribution, Using Multiple Draws

Description

Density, distribution function, quantile function and random generation for the Cauchy distribution, modified to work with rvecs.

Usage

dcauchy_rvec(x, location = 0, scale = 1, log = FALSE)
pcauchy_rvec(q, location = 0, scale = 1, lower.tail = TRUE, log.p = FALSE)
qcauchy_rvec(p, location = 0, scale = 1, lower.tail = TRUE, log.p = FALSE)
rcauchy_rvec(n, location = 0, scale = 1, n_draw = NULL)

Value

If any of the arguments are rvecs, or if a value for n_draw is supplied, then an rvec
Otherwise an ordinary R vector.

Arguments

x: Quantiles. Can be an rvec.
location: Center of distribution. Default is 0. See stats::dcauchy(). Can be an rvec.
scale: Scale parameter. Default is 1. See stats::dcauchy(). Can be an rvec.
log, log.p: Whether to return results on a log scale. Default is FALSE. Cannot be an rvec.
q: Quantiles. Can be an rvec.
lower.tail: Whether to return \(P[X \le x]\), as opposed to \(P[X > x]\). Default is TRUE. Cannot be an rvec.
p: Probabilities. Can be an rvec.
n: The length of random vector being created. Cannot be an rvec.
n_draw: Number of random draws in the random vector being created. Cannot be an rvec.

Details

Functions dcauchy_rvec(), pcauchy_rvec(), pcauchy_rvec() and rcauchy_rvec() work like base R functions dcauchy(), pcauchy(), qcauchy(), and rcauchy(), except that they accept rvecs as inputs. If any input is an rvec, then the output will be too. Function rcauchy_rvec() also returns an rvec if a value for n_draw is supplied.

dcauchy_rvec(), pcauchy_rvec(), pcauchy_rvec() and rcauchy_rvec() use tidyverse vector recycling rules:

Vectors of length 1 are recycled
All other vectors must have the same size

Examples

Run this code

x <- rvec(list(c(3, -5.1),
               c(0, -2.3)))
dcauchy_rvec(x)
pcauchy_rvec(x)

rcauchy_rvec(n = 2,
             location = c(-5, 5),
             n_draw = 1000)

Run the code above in your browser using DataLab