mnlChange: Maximal First Differences for Multinomial Logistic Regression...

In davidaarmstrong/damisc: Dave Armstrong's Miscellaneous Functions

Maximal First Differences for Multinomial Logistic Regression Models

Description

For objects of class multinom, it calculates the change in predicted probabilities, for maximal discrete changes in all covariates holding all other variables constant at typical values.

Usage

mnlChange(
  obj,
  data,
  typical.dat = NULL,
  diffchange = c("range", "sd", "unit"),
  n = 1,
  sim = TRUE,
  R = 1500
)

Arguments

obj	A model object of class multinom.
data	Data frame used to fit object.
typical.dat	Data frame with a single row containing values at which to hold variables constant when calculating first differences. These values will be passed to predict, so factors must take on a single value, but have all possible levels as their levels attribute.
diffchange	A string indicating the difference in predictor values to calculate the discrete change. range gives the difference between the minimum and maximum, sd gives plus and minus one-half standard deviation change around the median and unit gives a plus and minus one-half unit change around the median.
n	Number of diffchange units to change.
sim	Logical indicating whether simulated confidence bounds should be produced.
R	Number of simulations to perform if sim = TRUE

Details

The function calculates the changes in predicted probabilities for maximal discrete changes in the covariates for objects of class multinom. This function works with polynomials specified with the poly function. It also works with multiplicative interactions of the covariates by virtue of the fact that it holds all other variables at typical values. By default, typical values are the median for quantitative variables and the mode for factors. The way the function works with factors is a bit different. The function identifies the two most different levels of the factor and calculates the change in predictions for a change from the level with the smallest prediction to the level with the largest prediction.

Value

A list with the following elements:

diffs	A matrix of calculated first differences
minmax	A matrix of values that were used to calculate the predicted changes
minPred	A matrix of predicted probabilities when each variable is held at its minimum value, in turn.
maxPred	A matrix of predicted probabilities when each variable is held at its maximum value, in turn.

Author(s)

Dave Armstrong

Examples

library(nnet)
data(france)
mnl.mod <- multinom(vote ~ age + male + retnat + lrself, data=france)
typical.france <- data.frame(
	age = 35, 
	retnat = factor(1, levels=1:3, labels=levels(france$retnat)), 
	stringsAsFactors=TRUE)
mnlChange(mnl.mod, data=france, typical.dat=typical.france)	

davidaarmstrong/damisc documentation built on Oct. 1, 2023, 3:05 p.m.