cdf.ZTNegativeBinomial: Evaluate the cumulative distribution function of a...

In distributions3: Probability Distributions as S3 Objects

Evaluate the cumulative distribution function of a zero-truncated negative binomial distribution

Description

Evaluate the cumulative distribution function of a zero-truncated negative binomial distribution

Usage

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

Arguments

d	A ZTNegativeBinomial object created by a call to ZTNegativeBinomial().
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 pztnbinom. 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.

Examples

## set up a zero-truncated negative binomial distribution
X <- ZTNegativeBinomial(mu = 2.5, theta = 1)
X

## standard functions
pdf(X, 0:8)
cdf(X, 0:8)
quantile(X, seq(0, 1, by = 0.25))

## cdf() and quantile() are inverses for each other
quantile(X, cdf(X, 3))

## density visualization
plot(0:8, pdf(X, 0:8), type = "h", lwd = 2)

## corresponding sample with histogram of empirical frequencies
set.seed(0)
x <- random(X, 500)
hist(x, breaks = -1:max(x) + 0.5)

distributions3 documentation built on Sept. 30, 2024, 9:37 a.m.