biogeme.results_processing.pandas_output module

Generates the estimation results in Pandas

Michel Bierlaire Wed Oct 2 06:43:33 2024

biogeme.results_processing.pandas_output.get_pandas_correlation_results(estimation_results, variance_covariance_type=None, involved_parameters=None)[source]

Get the correlation results in a Pandas data frame

Parameters:

  • estimation_results (EstimationResults) – estimation results.

  • variance_covariance_type (EstimateVarianceCovariance | None) – type of variance-covariance estimate to be used.

  • involved_parameters (dict[str, str] | None) – a dict that identifies the parameters to involve, as assign them with a name for the reporting.

Return type:

DataFrame

Returns:

a Pandas data frame

biogeme.results_processing.pandas_output.get_pandas_estimated_parameters(estimation_results, variance_covariance_type=None, renumbering_parameters=None, renaming_parameters=None)[source]

Get the estimated parameters as a pandas data frame

Parameters:

  • estimation_results (EstimationResults) – estimation results.

  • variance_covariance_type (EstimateVarianceCovariance | None) – type of variance-covariance estimate to be used.

  • renumbering_parameters (dict[int, int] | None) – a dict that suggests new numbers for parameters

  • renaming_parameters (dict[str, str] | None) – a dict that suggests new names for some or all parameters.

  • variance_covariance_type – 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:

DataFrame

Returns:

a Pandas data frame

biogeme.results_processing.pandas_output.get_pandas_one_pair_of_parameters(estimation_results, first_parameter_index, second_parameter_index, variance_covariance_type, first_parameter_name=None, second_parameter_name=None)[source]

Generate one row of the Pandas table of the correlation data for estimated parameters.

Parameters:

  • estimation_results (EstimationResults) – estimation results.

  • first_parameter_index (int) – index of the first parameter

  • second_parameter_index (int) – index of the second parameter

  • variance_covariance_type (EstimateVarianceCovariance) – type of variance-covariance estimate to be used.

  • first_parameter_name – name of the parameter to report. If None, taken from estimation results.

  • second_parameter_name – name of the parameter to report. If None, taken from estimation results.

Return type:

dict[str, float | int | str]

Returns:

one row of the table

biogeme.results_processing.pandas_output.get_pandas_one_parameter(estimation_results, parameter_index, variance_covariance_type, parameter_number=None, parameter_name=None)[source]

Generate one row of the Pandas table of the estimated parameters.

Parameters:

  • estimation_results (EstimationResults) – estimation results.

  • parameter_index (int) – index of the parameter

  • variance_covariance_type (EstimateVarianceCovariance) – type of variance-covariance estimate to be used.

  • parameter_number – number of the parameter to report. If None, it is the index.

  • parameter_name – name of the parameter to report. If None, taken from estimation results.

Return type:

dict[str, float | int | str]

Returns:

one row of the table