biogeme.results_processing.f12_output module

Generates a F12 output for ALOGIT

Michel Bierlaire Thu Oct 3 10:09:52 2024

biogeme.results_processing.f12_output.generate_f12_file(estimation_results, filename, overwrite=False, variance_covariance_type=None)[source]

Generate a F12 file with the estimation results

Parameters:

  • estimation_results (EstimationResults) – estimation results

  • filename (str) – name of the file

  • overwrite – if True and the file exists, it is overwritten

  • variance_covariance_type (EstimateVarianceCovariance | None) – select which type of variance-covariance matrix is used to generate the statistics. If None, the bootstrap one is used if available. If not available, the robust one.

Return type:

None

biogeme.results_processing.f12_output.get_f12(estimation_results, variance_covariance_type=None)[source]

F12 is a format used by the software ALOGIT to report estimation results.

Parameters:
Return type:

str

Returns:

results formatted in F12 format