estimate: Estimate a Biogeme model

View source: R/results.R

estimateR Documentation

Estimate a Biogeme model

Description

Estimate a Biogeme model

Usage

estimate(
  model,
  model_name = "rbiogeme_model",
  controls = list(),
  starting_values = NULL,
  run_bootstrap = FALSE,
  yaml_file_name = NULL,
  control = NULL
)

Arguments

model

A biogeme_model, including a model created by logit_model() or another specialized constructor.

model_name

Output/model name used by Biogeme.

controls

Named list of Biogeme controls.

starting_values

Optional named numeric vector of starting values.

run_bootstrap

Whether to run bootstrap re-estimation.

yaml_file_name

Optional path for Biogeme's standard YAML output.

control

Optional biogeme_control() object; an alias for controls.

Details

estimate() always requests a fresh native estimation. It does not load a previous YAML or iteration file implicitly. Use estimate_or_load() when explicit result loading or recycling is required.

Value

An object of class biogeme_fit.

Examples

## Not run: 
fit <- estimate(
  model,
  model_name = "demo",
  control = biogeme_control(
    output_directory = tempfile("rbiogeme-estimate-"),
    generate_html = FALSE,
    generate_yaml = FALSE,
    save_iterations = FALSE
  )
)
summary(fit)

## End(Not run)

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