ssdtools: burrIII3 – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

burrIII3

Burr Type III Three-Parameter Distribution

Description

Density, distribution function, quantile function and random generation for the Burr Type III Three-Parameter distribution with lshape and lscale parameters.

Usage

dburrIII3(x, lshape1 = 0, lshape2 = 0, lscale = 0, log = FALSE)

qburrIII3(
  p,
  lshape1 = 0,
  lshape2 = 0,
  lscale = 0,
  lower.tail = TRUE,
  log.p = FALSE
)

pburrIII3(
  q,
  lshape1 = 0,
  lshape2 = 0,
  lscale = 0,
  lower.tail = TRUE,
  log.p = FALSE
)

rburrIII3(n, lshape1 = 0, lshape2 = 0, lscale = 0)

sburrIII3(x)

Arguments

`x`	The object.
`lshape1`	shape1 parameter on the log scale.
`lshape2`	shape2 parameter on the log scale.
`lscale`	scale parameter on the log scale.
`log`	logical; if TRUE, probabilities p are given as log(p).
`p`	vector of probabilities.
`lower.tail`	logical; if TRUE (default), probabilities are `P[X <= x]`,otherwise, `P[X > x]`.
`log.p`	logical; if TRUE, probabilities p are given as log(p).
`q`	vector of quantiles.
`n`	number of observations.

Details

The Burr 12 distribution from the actuar package is used as a base. The Burr III distribution is the distribution of 1/x where x has the Burr Type 12 distribution. refer to https://www.itl.nist.gov/div898/software/dataplot/refman2/auxillar/bu3pdf.htm for details. The shape1, shape2, and scale paramters are on the log(scale) as these must be positive.

Value

dburrIII3 gives the density, pburrIII3 gives the distribution function, qburrIII3 gives the quantile function, and rburrIII3 generates random samples.

Examples

x <- rburrIII3(1000)
hist(x, freq = FALSE, col = "gray", border = "white")
curve(dburrIII3(x), add = TRUE, col = "red4", lwd = 2)

ssdtools

Species Sensitivity Distributions

v0.3.3

Apache License (== 2.0) | file LICENSE

Authors

Joe Thorley [aut, cre, ctr] (<https://orcid.org/0000-0002-7683-4592>), Carl Schwarz [aut, ctr], Angeline Tillmanns [ctb], Ali Azizishirazi [ctb], Rebecca Fisher [ctb], David Fox [ctb], Kathleen McTavish [ctb], Heather Thompson [ctb], Andy Teucher [ctb], Emilie Doussantousse [ctb], Stephanie Hazlitt [ctb], Nadine Hussein [ctb], Nan-Hung Hsieh [ctb], Sergio Ibarra Espinosa [ctb], Province of British Columbia [cph]

Initial release