Man pages for rbiogeme
Interface to 'Biogeme'
| abs.biogeme_expression | Absolute value of a Biogeme expression |
| assisted_specification | Run native Biogeme assisted specification |
| bayesian_estimate | Estimate a model with native Bayesian inference |
| bayesian_posterior_mean_by_observation | Retrieve native posterior means by observation |
| bayesian_stored_variables | Report variables stored in native Bayesian results |
| biogeme_beta | Create a Biogeme parameter |
| biogeme_bridge | Locate and import the package's Python bridge. |
| biogeme_catalog | Create a native-compatible expression catalog |
| biogeme_catalog_controller | Create a neutral controller for one or more expression... |
| biogeme_check | Check whether rbiogeme is ready to run a model |
| biogeme_confidence_intervals | Calculate native simulation confidence intervals |
| biogeme_config | Configure the Python runtime used by rbiogeme |
| biogeme_control | Define estimation and simulation controls |
| biogeme_database | Create a Biogeme database |
| biogeme_database_columns | Return the columns available in a Biogeme database |
| biogeme_database_define_variable | Define a derived database variable using a complete Biogeme... |
| biogeme_database_extract_rows | Extract observations from a Biogeme database |
| biogeme_database_filtered_row_count | Return the number of observations excluded by native database... |
| biogeme_database_has_column | Test whether a Biogeme database contains a column |
| biogeme_database_is_panel | Return whether a database has a declared panel structure |
| biogeme_database_materialize | Materialize lazy database operations through native Biogeme |
| biogeme_database_nrow | Return the number of rows currently represented by a database |
| biogeme_database_panel | Declare and validate a panel identifier |
| biogeme_database_remove | Remove observations satisfying a Biogeme logical expression |
| biogeme_database_row_ids | Return the original row identifiers of a Biogeme database |
| biogeme_database_segmentation | Generate a native-compatible segmentation specification from... |
| biogeme_diagnostics | Report the active R, Python, Biogeme, and numerical-library... |
| biogeme_draws | Declare first-class draw metadata for a model |
| biogeme_error_details | Return the diagnostic details attached to a Biogeme error |
| biogeme_function | Create a Biogeme function node |
| biogeme_general_statistics | Return native Biogeme general estimation statistics |
| biogeme_generic_alt_specific_catalogs | Build synchronized generic/alternative-specific catalogs |
| biogeme_max | Maximum of Biogeme expressions |
| biogeme_mdcev_model | Construct an MDCEV model specification |
| biogeme_min | Minimum of Biogeme expressions |
| biogeme_model | Create a generic Biogeme model |
| biogeme_model_parameters | Return the parameter definitions in a model |
| biogeme_native_parameter_names | Return parameter names collected from the compiled native... |
| biogeme_panel_database | Construct a panel database in one call |
| biogeme_prior | Declare a native Bayesian prior |
| biogeme_python | Initialize and return the Python interpreter used by rbiogeme |
| biogeme_sampling_partition | Define a native Biogeme sampling partition |
| biogeme_segmentation | Define a discrete parameter segmentation |
| biogeme_segmentation_catalogs | Build synchronized catalogs for possible parameter... |
| biogeme_setup | Automatically prepare the native Biogeme runtime |
| boxcox | Box-Cox transformation |
| catalog_configuration_ids | Return catalog configuration identifiers using native Biogeme |
| check_derivatives | Check analytical derivatives against native finite... |
| check_monte_carlo_stability | Run native post-estimation Monte Carlo draw-stability... |
| collect_biogeme_parameters | Collect parameter names from an expression |
| collect_biogeme_variables | Collect data-variable names from an expression |
| count_number_of_specifications | Count catalog specifications using native Biogeme |
| cross_nested_logit_correlation | Calculate the native cross-nested-logit error-term... |
| cross_nested_logit_model | Define a cross-sectional cross-nested-logit model |
| cross_nested_log_probability | Construct a native cross-nested-logit log-probability... |
| cross_nested_nest | Define one cross-nested-logit nest |
| cross_nested_nests | Define the complete cross-nested-logit nest structure |
| cross_nested_probability | Construct a native cross-nested-logit probability expression |
| cross_nested_sparsity_report | Summarize the structural sparsity of a CNL nest specification |
| cross_variable | Define a sampled-alternative cross-variable |
| derive | Symbolically differentiate an expression with respect to a... |
| distributed_parameter | Store a simulated individual-level parameter in Bayesian... |
| draw | Create a named Biogeme draw node |
| Elem | Select an expression from a numeric mapping |
| estimate | Estimate a Biogeme model |
| estimate_catalog | Estimate every specification in a native Biogeme catalog |
| estimate_configuration | Estimate one named native catalog configuration |
| estimate_or_load | Estimate or explicitly load a standard Biogeme result |
| estimate_sampled_alternatives | Estimate a native sampled-alternative model |
| evaluate_biogeme_expression | Evaluate a standalone expression with native Biogeme |
| evaluate_biogeme_expression_c | Evaluate one expression with native row-wise or aggregated... |
| integrate_normal | Integrate an expression over a standard normal random... |
| linear_term | Define one coefficient-variable term for a linear utility |
| linear_utility | Construct a native linear utility expression |
| logit_log_probability | Construct a native logit log-probability expression |
| logit_model | Define a cross-sectional multinomial logit model |
| logit_probability | Construct a native logit probability expression |
| logzero | A numerically safe logarithm that returns zero at zero |
| mdcev_estimate | Estimate an MDCEV model with native Biogeme |
| mdcev_forecast | Forecast MDCEV consumption using native Biogeme algorithms |
| mdcev_forecast_describe | Return native pandas description tables for an MDCEV forecast |
| mdcev_generate_epsilons | Generate native MDCEV error-term draws |
| mdcev_parameter_table | Return native Biogeme's estimated-parameter table for an... |
| mdcev_short_summary | Return native Biogeme's compact MDCEV estimation summary |
| mdcev_validate_forecast | Validate the two native MDCEV forecasting algorithms |
| monte_carlo | Monte Carlo average of an expression |
| nested_endogenous_sampling_log_probability | Construct a native nested-logit log probability with... |
| nested_logit_correlation | Calculate the native nested-logit error-term correlation... |
| nested_logit_model | Define a cross-sectional nested-logit model |
| nested_log_probability | Construct a native nested-logit log-probability expression |
| nested_nest | Define one non-trivial nested-logit nest |
| nested_nests | Define the complete nested-logit nest structure |
| nested_probability | Construct a native nested-logit probability expression |
| new_biogeme_expression | Create a Biogeme expression node |
| normal_cdf | Normal cumulative distribution function |
| normal_pdf | Normal probability density function |
| ordered_logit_log_probability | Construct an ordered-logit log-likelihood expression |
| ordered_probit_log_probability | Construct an ordered-probit log-likelihood expression |
| ordered_response_log_probability | Construct a native ordered-response log-likelihood expression |
| panel_likelihood_trajectory | Aggregate an observation-level likelihood over a panel... |
| pareto_post_processing | Re-estimate the Pareto-optimal models saved by native Biogeme |
| piecewise | Piecewise-linear expression using native Biogeme naming rules |
| predict.biogeme_fit | Predict native probabilities or simulation expressions |
| profile_jax | Profile native JAX formula evaluation |
| quick_estimate | Estimate a Biogeme model using the native quick-estimation... |
| random_variable | Create a random variable for native numerical integration |
| rbiogeme-package | Interface to Biogeme |
| read_results | Read standard Biogeme YAML results |
| safe_exp | Numerically safe exponential |
| sampled_alternatives_model | Define a sampled-alternative Biogeme model |
| sampling_segment_sizes | Generate balanced sampling segment sizes |
| save_results | Save standard Biogeme YAML results |
| segment_beta | Create a segmented parameter expression |
| simulate | Simulate named native Biogeme expressions at fixed estimates |
| simulate_bayesian | Simulate formulas over Bayesian posterior draws |
| simulate_single_formula | Evaluate one native Biogeme formula as an aggregated scalar |
| sqrt.biogeme_expression | Square root of a Biogeme expression |
| swissmetro_b01b_model | Build the segmented linear-utility Swissmetro specification... |
| swissmetro_data | Prepare the Swissmetro database used by Biogeme's examples |
| swissmetro_mnl_model | Build the baseline Swissmetro MNL specification |
| validate | Validate a model using native Biogeme cross-validation |
| validate_biogeme_data | Validate a data frame for use as a Biogeme database |
| validate_model | Validate a model before estimation |
| variable | Create a Biogeme data variable |
