mblogit: Baseline-Category Logit Models for Categorical and...

View source: R/mblogit.R

mblogitR Documentation

Baseline-Category Logit Models for Categorical and Multinomial Responses


The function mblogit fits baseline-category logit models for categorical and multinomial count responses with fixed alternatives.


  data = parent.frame(),
  random = NULL,
  catCov = c("free", "diagonal", "single"),
  weights = NULL,
  na.action = getOption("na.action"),
  model = TRUE,
  x = FALSE,
  y = TRUE,
  contrasts = NULL,
  method = NULL,
  estimator = c("ML", "REML"),
  dispersion = FALSE,
  start = NULL,
  from.table = FALSE,
  groups = NULL,
  control = if (length(random)) mmclogit.control(...) else mclogit.control(...),



the model formula. The response must be a factor or a matrix of counts.


an optional data frame, list or environment (or object coercible by as.data.frame to a data frame) containing the variables in the model. If not found in data, the variables are taken from environment(formula), typically the environment from which glm is called.


an optional formula or list of formulas that specify the random-effects structure or NULL.


a character string that specifies optional restrictions on the covariances of random effects between the logit equations. "free" means no restrictions, "diagonal" means that random effects pertinent to different categories are uncorrelated, while "single" means that the random effect variances pertinent to all categories are identical.


an optional vector specifying a subset of observations to be used in the fitting process.


an optional vector of weights to be used in the fitting process. Should be NULL or a numeric vector.


a function which indicates what should happen when the data contain NAs. The default is set by the na.action setting of options, and is na.fail if that is unset. The ‘factory-fresh’ default is na.omit. Another possible value is NULL, no action. Value na.exclude can be useful.


a logical value indicating whether model frame should be included as a component of the returned value.

x, y

logical values indicating whether the response vector and model matrix used in the fitting process should be returned as components of the returned value.


an optional list. See the contrasts.arg of model.matrix.default.


NULL or a character string, either "PQL" or "MQL", specifies the type of the quasilikelihood approximation to be used if a random-effects model is to be estimated.


a character string; either "ML" or "REML", specifies which estimator is to be used/approximated.


a logical value or a character string; whether and how a dispersion parameter should be estimated. For details see dispersion.


an optional matrix of starting values (with as many rows as logit equations). If the model has random effects, the matrix should have a "VarCov" attribute wtih starting values for the random effects (co-)variances. If the random effects model is estimated with the "PQL" method, the starting values matrix should also have a "random.effects" attribute, which should have the same structure as the "random.effects" component of an object returned by mblogit().


a logical value; do the data represent a contingency table, e.g. were created by applying as.data.frame() a the result of table() or xtabs(). This relevant only if the response is a factor. This argument should be set to TRUE if the data do come from a contingency table. Correctly setting from.table=TRUE in this case, will lead to efficiency gains in computing, but more importantly overdispersion will correctly be computed if present.


an optional formula that specifies groups of observations relevant for the specification of overdispersed response counts.


a list of parameters for the fitting process. See mclogit.control


arguments to be passed to mclogit.control or mmclogit.control


The function mblogit internally rearranges the data into a 'long' format and uses mclogit.fit to compute estimates. Nevertheless, the 'user data' are unaffected.


mblogit returns an object of class "mblogit", which has almost the same structure as an object of class "glm". The difference are the components coefficients, residuals, fitted.values, linear.predictors, and y, which are matrices with number of columns equal to the number of response categories minus one.


Agresti, Alan. 2002. Categorical Data Analysis. 2nd ed, Hoboken, NJ: Wiley. doi: 10.1002/0471249688

Breslow, N.E. and D.G. Clayton. 1993. "Approximate Inference in Generalized Linear Mixed Models". Journal of the American Statistical Association 88 (421): 9-25. doi: 10.1080/01621459.1993.10594284

See Also

The function multinom in package nnet also fits multinomial baseline-category logit models, but has a slightly less convenient output and does not support overdispersion or random effects. However, it provides some other options. Baseline-category logit models are also supported by the package VGAM, as well as some reduced-rank and (semi-parametric) additive generalisations. The package mnlogit estimates logit models in a way optimized for large numbers of alternatives.


library(MASS) # For 'housing' data

(house.mult<- multinom(Sat ~ Infl + Type + Cont, weights = Freq,
                       data = housing))

(house.mblogit <- mblogit(Sat ~ Infl + Type + Cont, weights = Freq,
                         data = housing))




mclogit documentation built on Oct. 29, 2022, 1:09 a.m.

Related to mblogit in mclogit...