VGAM (version 1.0-6)

zabinomial: Zero-Altered Binomial Distribution

Description

Fits a zero-altered binomial distribution based on a conditional model involving a Bernoulli distribution and a positive-binomial distribution.

Usage

zabinomial(lpobs0 = "logit", lprob = "logit",
           type.fitted = c("mean", "prob", "pobs0"),
           ipobs0 = NULL, iprob = NULL, imethod = 1, zero = NULL)
zabinomialff(lprob = "logit", lonempobs0 = "logit",
             type.fitted = c("mean", "prob", "pobs0", "onempobs0"),
             iprob = NULL, ionempobs0 = NULL, imethod = 1, zero = "onempobs0")

Arguments

lprob

Parameter link function applied to the probability parameter of the binomial distribution. See Links for more choices.

lpobs0

Link function for the parameter \(p_0\), called pobs0 here. See Links for more choices.

type.fitted

See CommonVGAMffArguments and fittedvlm for information.

iprob, ipobs0

See CommonVGAMffArguments.

lonempobs0, ionempobs0

Corresponding argument for the other parameterization. See details below.

imethod, zero

See CommonVGAMffArguments.

Value

An object of class "vglmff" (see vglmff-class). The object is used by modelling functions such as vglm, and vgam.

The fitted.values slot of the fitted object, which should be extracted by the generic function fitted, returns the mean \(\mu\) (default) which is given by $$\mu = (1-p_0) \mu_{b} / [1 - (1 - \mu_{b})^N]$$ where \(\mu_{b}\) is the usual binomial mean. If type.fitted = "pobs0" then \(p_0\) is returned.

Details

The response \(Y\) is zero with probability \(p_0\), else \(Y\) has a positive-binomial distribution with probability \(1-p_0\). Thus \(0 < p_0 < 1\), which may be modelled as a function of the covariates. The zero-altered binomial distribution differs from the zero-inflated binomial distribution in that the former has zeros coming from one source, whereas the latter has zeros coming from the binomial distribution too. The zero-inflated binomial distribution is implemented in zibinomial. Some people call the zero-altered binomial a hurdle model.

The input is currently a vector or one-column matrix. By default, the two linear/additive predictors for zabinomial() are \((logit(p_0), \log(p))^T\).

The VGAM family function zabinomialff() has a few changes compared to zabinomial(). These are: (i) the order of the linear/additive predictors is switched so the binomial probability comes first; (ii) argument onempobs0 is now 1 minus the probability of an observed 0, i.e., the probability of the positive binomial distribution, i.e., onempobs0 is 1-pobs0; (iii) argument zero has a new default so that the onempobs0 is intercept-only by default. Now zabinomialff() is generally recommended over zabinomial(). Both functions implement Fisher scoring and neither can handle multiple responses.

See Also

dzabinom, zibinomial, posbinomial, binomialff, dbinom, CommonVGAMffArguments.

Examples

# NOT RUN {
zdata <- data.frame(x2 = runif(nn <- 1000))
zdata <- transform(zdata, size  = 10,
                          prob  = logit(-2 + 3*x2, inverse = TRUE),
                          pobs0 = logit(-1 + 2*x2, inverse = TRUE))
zdata <- transform(zdata,
                   y1 = rzabinom(nn, size = size, prob = prob, pobs0 = pobs0))
with(zdata, table(y1))

zfit <- vglm(cbind(y1, size - y1) ~ x2, zabinomial(zero = NULL),
             data = zdata, trace = TRUE)
coef(zfit, matrix = TRUE)
head(fitted(zfit))
head(predict(zfit))
summary(zfit)
# }