cdf.NegativeBinomial: Evaluate the cumulative distribution function of a negative...

In alexpghayes/distributions: Probability Distributions as S3 Objects

Evaluate the cumulative distribution function of a negative binomial distribution

Description

Evaluate the cumulative distribution function of a negative binomial distribution

Usage

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

Arguments

d	A NegativeBinomial object created by a call to NegativeBinomial().
x	A vector of elements whose cumulative probabilities you would like to determine given the distribution d.
drop	logical. Should the result be simplified to a vector if possible?
elementwise	logical. Should each distribution in d be evaluated at all elements of x (elementwise = FALSE, yielding a matrix)? Or, if d and x 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 pnbinom. 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(x) columns (if drop = FALSE). In case of a vectorized distribution object, a matrix with length(x) columns containing all possible combinations.

See Also

Other NegativeBinomial distribution: pdf.NegativeBinomial(), quantile.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)

alexpghayes/distributions documentation built on Sept. 23, 2024, 4:49 p.m.