quantile.NegativeBinomial: Determine quantiles of a NegativeBinomial distribution

In distributions3: Probability Distributions as S3 Objects

Determine quantiles of a NegativeBinomial distribution

Description

Determine quantiles of a NegativeBinomial distribution

Usage

## S3 method for class 'NegativeBinomial'
quantile(x, probs, drop = TRUE, elementwise = NULL, ...)

Arguments

x	A NegativeBinomial object created by a call to NegativeBinomial().
probs	A vector of probabilities.
drop	logical. Should the result be simplified to a vector if possible?
elementwise	logical. Should each distribution in x be evaluated at all elements of probs (elementwise = FALSE, yielding a matrix)? Or, if x and probs have the same length, should the evaluation be done element by element (elementwise = TRUE, yielding a vector)? The default of NULL means that elementwise = TRUE is used if the lengths match and otherwise elementwise = FALSE is used.
...	Arguments to be passed to qnbinom. Unevaluated arguments will generate a warning to catch mispellings or other possible errors.

Value

In case of a single distribution object, either a numeric vector of length probs (if drop = TRUE, default) or a matrix with length(probs) columns (if drop = FALSE). In case of a vectorized distribution object, a matrix with length(probs) columns containing all possible combinations.

See Also

Other NegativeBinomial distribution: cdf.NegativeBinomial(), pdf.NegativeBinomial(), random.NegativeBinomial()

Examples

set.seed(27)

X <- NegativeBinomial(size = 5, p = 0.1)
X

random(X, 10)

pdf(X, 50)
log_pdf(X, 50)

cdf(X, 50)
quantile(X, 0.7)

## alternative parameterization of X
Y <- NegativeBinomial(mu = 45, size = 5)
Y
cdf(Y, 50)
quantile(Y, 0.7)

distributions3 documentation built on Sept. 7, 2022, 5:07 p.m.