dt_rvec: Student t Distribution, Using Multiple Draws

Description

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

Usage

dt_rvec(x, df, ncp = 0, log = FALSE)
pt_rvec(q, df, ncp = 0, lower.tail = TRUE, log.p = FALSE)
qt_rvec(p, df, ncp = 0, lower.tail = TRUE, log.p = FALSE)
rt_rvec(n, df, ncp = 0, 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.
df: Degrees of freedom. See stats::dt(). Can be an rvec.
ncp: Non-centrality parameter. Default is 0. See stats::dt(). Cannot 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 dt_rvec(), pt_rvec(), pt_rvec() and rt_rvec() work like base R functions dt(), pt(), qt(), and rt(), except that they accept rvecs as inputs. If any input is an rvec, then the output will be too. Function rt_rvec() also returns an rvec if a value for n_draw is supplied.

dt_rvec(), pt_rvec(), pt_rvec() and rt_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.2, 5.3),
               c(-1.6, 2)))
dt_rvec(x, df = 4)
pt_rvec(x, df = 4)

rt_rvec(n = 2,
        df = c(3, 5),
        n_draw = 1000)

Run the code above in your browser using DataLab