biogeme_mdcev_model: Construct an MDCEV model specification

View source: R/mdcev.R

biogeme_mdcev_modelR Documentation

Construct an MDCEV model specification

Description

This is a declarative model object. The alternative utilities, shape parameters, and observed consumptions remain neutral R expression trees until the Python bridge sends the complete specification to the native Biogeme engine. The likelihood and forecasting algorithms are therefore provided by Biogeme itself.

Usage

biogeme_mdcev_model(
  database,
  model_type = c("gamma_profile", "generalized", "translated", "non_monotonic"),
  baseline_utilities,
  gamma_parameters,
  alpha_parameters = NULL,
  mu_utilities = NULL,
  scale_parameter = NULL,
  prices = NULL,
  weights = NULL,
  number_of_chosen_alternatives,
  consumed_quantities,
  subset = NULL,
  control = NULL
)

mdcev_model(
  database,
  model_type = c("gamma_profile", "generalized", "translated", "non_monotonic"),
  baseline_utilities,
  gamma_parameters,
  alpha_parameters = NULL,
  mu_utilities = NULL,
  scale_parameter = NULL,
  prices = NULL,
  weights = NULL,
  number_of_chosen_alternatives,
  consumed_quantities,
  subset = NULL,
  control = NULL
)

Arguments

database

A biogeme_database() object.

model_type

One of "gamma_profile", "generalized", "translated", or "non_monotonic".

baseline_utilities

Non-empty named list of baseline utility expressions, keyed by integer alternative code.

gamma_parameters

Named list of gamma expressions, keyed by the same alternatives. One value may be NULL to declare an outside good.

alpha_parameters

Named list of alpha expressions. Required for the generalized, translated, and non-monotonic variants.

mu_utilities

Named list of non-monotonic utility expressions.

scale_parameter

Optional scale expression.

prices

Optional named list of price expressions. Supported by the gamma-profile and generalized native classes.

weights

Optional observation-weight expression.

number_of_chosen_alternatives

Expression containing the number of goods chosen in each observation.

consumed_quantities

Named list of observed consumption expressions.

subset

Optional logical expression selecting observations to remove when it is false, using the same semantics as biogeme_model().

control

Optional biogeme_control() object.

Value

An object of class biogeme_mdcev_model.


rbiogeme documentation built on Sept. 29, 2026, 5:09 p.m.