Description Usage Arguments Details Value References See Also Examples
Fit beta regression models for rates and proportions via maximum likelihood using a parametrization with mean (depending through a link function on the covariates) and precision parameter (called phi).
1 2 3 4 5 6 7 8 9 10  betareg(formula, data, subset, na.action, weights, offset,
link = c("logit", "probit", "cloglog", "cauchit", "log", "loglog"),
link.phi = NULL, type = c("ML", "BC", "BR"),
dist = c("beta", "cbeta4", "cbetax"), nu = NULL,
control = betareg.control(...), model = TRUE,
y = TRUE, x = FALSE, ...)
betareg.fit(x, y, z = NULL, weights = NULL, offset = NULL,
link = "logit", link.phi = "log", type = "ML", control = betareg.control(),
dist = "beta", nu = NULL)

formula 
symbolic description of the model (of type 
data, subset, na.action 
arguments controlling formula processing
via 
weights 
optional numeric vector of case weights. 
offset 
optional numeric vector with an a priori known component to be
included in the linear predictor for the mean. In 
link 
character specification of the link function in
the mean model (mu). Currently, 
link.phi 
character specification of the link function in
the precision model (phi). Currently, 
type 
character specification of the type of estimator. Currently,
maximum likelihood ( 
dist 
character specification of the response distribution.
If all response observation are in (0, 1) the default is the standard
beta distribution. In the presence of boundary 0/1 observations, a
censored constrained fourparameter beta distribution ( 
nu 
numeric. The value of the (fixed) 
control 
a list of control arguments specified via

model, y, x 
logicals. If 
z 
numeric matrix. Regressor matrix for the precision model, defaulting to an intercept only. 
... 
arguments passed to 
Beta regression as suggested by Ferrari and CribariNeto (2004) and extended
by Simas, BarretoSouza, and Rocha (2010) is implemented in betareg
.
It is useful in situations where the dependent variable is continuous and restricted to
the unit interval (0, 1), e.g., resulting from rates or proportions. It is modeled to be
betadistributed with parametrization using mean and precision parameter (called phi).
The mean is linked, as in generalized linear models (GLMs), to the responses through a link
function and a linear predictor. Additionally, the precision parameter phi can be linked
to another (potentially overlapping) set of regressors through a second link function,
resulting in a model with variable dispersion.
Estimation is performed by maximum likelihood (ML) via optim
using
analytical gradients and (by default) starting values from an auxiliary linear regression
of the transformed response. Subsequently, the optim
result may be enhanced
by an additional Fisher scoring iteration using analytical gradients and expected information.
This slightly improves the optimization by moving the gradients even closer to zero
(for type = "ML"
and "BC"
) or solving the biasadjusted estimating equations
(for type = "BR"
). For the former two estimators, the optional Fisher scoring
can be disabled by setting fsmaxit = 0
in the control arguments. See
CribariNeto and Zeileis (2010) and Grün et al. (2012) for details.
In the beta regression as introduced by Ferrari and CribariNeto (2004), the mean of
the response is linked to a linear predictor described by y ~ x1 + x2
using
a link
function while the precision parameter phi is assumed to be
constant. Simas et al. (2009) suggest to extend this model by linking phi to an
additional set of regressors (z1 + z2
, say): In betareg
this can be
specified in a formula of type y ~ x1 + x2  z1 + z2
where the regressors
in the two parts can be overlapping. In the precision model (for phi), the link
function link.phi
is used. The default is a "log"
link unless no
precision model is specified. In the latter case (i.e., when the formula is of type
y ~ x1 + x2
), the "identity"
link is used by default for backward
compatibility.
Simas et al. (2009) also suggest further extensions (nonlinear specificiations,
bias correction) which are not yet implemented in betareg
. However,
Kosmidis and Firth (2010) discuss general algorithms for bias correction/reduction,
both of which are available in betareg
by setting the type
argument
accordingly. (Technical note: In case, either bias correction or reduction is requested,
the second derivative of the inverse link function is required for link
and
link.phi
. If the two links are specified by their names (as done by default
in betareg
), then the "linkglm"
objects are enhanced automatically
by the required additional d2mu.deta
function. However, if a "linkglm"
object is supplied directly by the user, it needs to have the d2mu.deta
function or, for backward compatibility, dmu.deta
.)
The main parameters of interest are the coefficients in the linear predictor of the mean
model. The additional parameters in the precision model (phi) can either
be treated as full model parameters (default) or as nuisance parameters. In the latter case
the estimation does not change, only the reported information in output from print
,
summary
, or coef
(among others) will be different. See also betareg.control
.
A set of standard extractor functions for fitted model objects is available for
objects of class "betareg"
, including methods to the generic functions
print
, summary
, plot
, coef
,
vcov
, logLik
, residuals
,
predict
, terms
,
model.frame
, model.matrix
,
cooks.distance
and hatvalues
(see influence.measures
),
gleverage
(new generic), estfun
and
bread
(from the sandwich package), and
coeftest
(from the lmtest package).
See predict.betareg
, residuals.betareg
, plot.betareg
,
and summary.betareg
for more details on all methods.
The original version of the package was written by Alexandre B. Simas and Andrea V. Rocha (up to version 1.2). Starting from version 2.00 the code was rewritten by Achim Zeileis.
betareg
returns an object of class "betareg"
, i.e., a list with components as follows.
betareg.fit
returns an unclassed list with components up to converged
.
coefficients 
a list with elements 
residuals 
a vector of raw residuals (observed  fitted), 
fitted.values 
a vector of fitted means, 
optim 
output from the 
method 
the method argument passed to the 
control 
the control arguments passed to the 
start 
the starting values for the parameters passed to the 
weights 
the weights used (if any), 
offset 
a list of offset vectors used (if any), 
n 
number of observations, 
nobs 
number of observations with nonzero weights, 
df.null 
residual degrees of freedom in the null model (constant mean and dispersion),
i.e., 
df.residual 
residual degrees of freedom in the fitted model, 
phi 
logical indicating whether the precision (phi) coefficients will be
treated as full model parameters or nuisance parameters in subsequent calls to

loglik 
loglikelihood of the fitted model, 
vcov 
covariance matrix of all parameters in the model, 
pseudo.r.squared 
pseudo Rsquared value (squared correlation of linear predictor and linktransformed response), 
link 
a list with elements 
converged 
logical indicating successful convergence of 
call 
the original function call, 
formula 
the original formula, 
terms 
a list with elements 
levels 
a list with elements 
contrasts 
a list with elements 
model 
the full model frame (if 
y 
the response proportion vector (if 
x 
a list with elements 
CribariNeto, F., and Zeileis, A. (2010). Beta Regression in R. Journal of Statistical Software, 34(2), 1–24. http://www.jstatsoft.org/v34/i02/.
Ferrari, S.L.P., and CribariNeto, F. (2004). Beta Regression for Modeling Rates and Proportions. Journal of Applied Statistics, 31(7), 799–815.
Grün, B., Kosmidis, I., and Zeileis, A. (2012). Extended Beta Regression in R: Shaken, Stirred, Mixed, and Partitioned. Journal of Statistical Software, 48(11), 1–25. http://www.jstatsoft.org/v48/i11/.
Kosmidis, I., and Firth, D. (2010). A Generic Algorithm for Reducing Bias in Parametric Estimation. Electronic Journal of Statistics, 4, 1097–1112.
Simas, A.B., BarretoSouza, W., and Rocha, A.V. (2010). Improved Estimators for a General Class of Beta Regression Models. Computational Statistics & Data Analysis, 54(2), 348–366.
summary.betareg
, predict.betareg
, residuals.betareg
,
Formula
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33  options(digits = 4)
## Section 4 from Ferrari and CribariNeto (2004)
data("GasolineYield", package = "betareg")
data("FoodExpenditure", package = "betareg")
## Table 1
gy < betareg(yield ~ batch + temp, data = GasolineYield)
summary(gy)
## Table 2
fe_lin < lm(I(food/income) ~ income + persons, data = FoodExpenditure)
library("lmtest")
bptest(fe_lin)
fe_beta < betareg(I(food/income) ~ income + persons, data = FoodExpenditure)
summary(fe_beta)
## nested model comparisons via Wald and LR tests
fe_beta2 < betareg(I(food/income) ~ income, data = FoodExpenditure)
lrtest(fe_beta, fe_beta2)
waldtest(fe_beta, fe_beta2)
## Section 3 from online supplements to Simas et al. (2010)
## mean model as in gy above
## precision model with regressor temp
gy2 < betareg(yield ~ batch + temp  temp, data = GasolineYield)
## MLE column in Table 19
summary(gy2)
## LRT row in Table 18
lrtest(gy, gy2)

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.
Please suggest features or report bugs in the GitHub issue tracker.
All documentation is copyright its authors; we didn't write any of that.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.