mnl_predict: Prediction of choice probabilities and utilities based on...

In choicer: Discrete Choice Models for Economic Applications

Prediction of choice probabilities and utilities based on fitted model

Description

Prediction of choice probabilities and utilities based on fitted model

Usage

mnl_predict(
  theta,
  X,
  alt_idx,
  M,
  use_asc = TRUE,
  include_outside_option = FALSE
)

Arguments

theta	K + J - 1 or K + J vector with model parameters
X	sum(M) x K design matrix with covariates. Stacks M[i] x K matrices for individual i.
alt_idx	sum(M) x 1 vector with indices of alternatives within each choice set; 1-based indexing
M	N x 1 vector with number of alternatives for each individual
use_asc	whether to use alternative-specific constants
include_outside_option	whether to include outside option normalized to 0 (if so, the outside option is not included in the data)

Value

List with choice probability and utility for each choice situation evaluated at input arguments

Examples

library(data.table)
set.seed(42)
N <- 50; J <- 3
dt <- data.table(id = rep(1:N, each = J), alt = rep(1:J, N))
dt[, `:=`(x1 = rnorm(.N), x2 = rnorm(.N))]
dt[, choice := 0L]
dt[, choice := sample(c(1L, rep(0L, J - 1))), by = id]
fit <- run_mnlogit(dt, "id", "alt", "choice", c("x1", "x2"))
pred <- choicer:::mnl_predict(coef(fit), fit$data$X, fit$data$alt_idx,
  fit$data$M, use_asc = TRUE)
head(pred$choice_prob)

choicer documentation built on Sept. 5, 2026, 1:07 a.m.