biogeme_control: Define estimation and simulation controls

In rbiogeme: Interface to 'Biogeme'

Define estimation and simulation controls

Description

Unspecified fields are omitted so native Biogeme defaults remain in force. Additional named arguments are passed through to the native bridge.

Usage

biogeme_control(
  model_name = NULL,
  output_directory = NULL,
  seed = NULL,
  numerically_safe = NULL,
  second_derivatives = NULL,
  second_derivatives_percentage = NULL,
  optimization_algorithm = NULL,
  number_of_draws = NULL,
  draw_type = NULL,
  draw_seed = NULL,
  bootstrap_samples = NULL,
  user_notes = NULL,
  variance_covariance_type = NULL,
  save_iterations = NULL,
  generate_html = NULL,
  generate_yaml = NULL,
  validation_folds = NULL,
  ...
)

Arguments

model_name	Optional native Biogeme model name.
output_directory	Optional explicit directory for native files. It is required whenever a control requests native HTML, YAML, NetCDF, pickle, or iteration output; no operation writes to the working directory by default.
seed	Optional random seed.
numerically_safe	Optional numerical-safety flag.
second_derivatives	Optional second-derivative policy.
second_derivatives_percentage	Optional native percentage of iterations using analytical second derivatives.
optimization_algorithm	Optional native algorithm name.
number_of_draws	Optional number of simulation draws.
draw_type	Optional default draw type metadata.
draw_seed	Optional draw seed (mapped to native seed).
bootstrap_samples	Optional bootstrap sample count.
user_notes	Optional notes included in native reports/results.
variance_covariance_type	Optional result covariance selection, such as "BHHH" or "Bootstrap".
save_iterations	Optional iteration-file persistence flag.
generate_html	Optional HTML-report flag.
generate_yaml	Optional YAML-report flag.
validation_folds	Optional validation-fold count.
...	Additional native Biogeme controls.

Details

Unspecified values are omitted. This lets native Biogeme apply its normal defaults. The control object can be stored in a model or passed to an estimation or simulation operation; it is not a Python object.

Value

A named list of controls.

Examples

biogeme_control(
  seed = 1234,
  generate_html = FALSE,
  generate_yaml = FALSE,
  save_iterations = FALSE
)

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