simulate: Simulate named native Biogeme expressions at fixed estimates

In rbiogeme: Interface to 'Biogeme'

Simulate named native Biogeme expressions at fixed estimates

Description

Simulate named native Biogeme expressions at fixed estimates

Usage

simulate(model, expressions = NULL, beta, control = NULL, database = NULL)

Arguments

model	A biogeme_model.
expressions	Optional named list of expressions. When omitted, the model's simulations list is used.
beta	A biogeme_fit or named numeric parameter vector.
control	Optional biogeme_control() object.
database	Optional scenario database. It may be a biogeme_database or a numeric data frame. A data frame inherits the model database's derived-variable, filter, and panel metadata.

Details

expressions is a named list of complete symbolic expressions. When it is omitted, the model's simulations list is used. Native Biogeme evaluates these expressions at the supplied parameter values and returns ordinary R data frames.

Value

A biogeme_simulation object containing a data frame of values.

Examples

## Not run: 
simulation_model <- biogeme_model(
  database,
  formula = choice_log_probability,
  simulations = list(probability = choice_probability)
)
simulated <- simulate(
  simulation_model,
  beta = fit,
  control = biogeme_control(output_directory = tempfile("rbiogeme-sim-"))
)
as.data.frame(simulated)

## End(Not run)

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