# ambric

> Augmented Mixed-frequency Bayesian Regional Inference with Constraints

## Docs

### API Reference

#### Classes
> Main classes provided by the package

- [Ambric](reference/Ambric.html): Augmented Mixed-frequency Bayesian Regional Inference with Constraints

#### Ambric Methods
> Methods for the Ambric class

- [Ambric.__repr__](reference/Ambric.__repr__.html)
- [Ambric.fit](reference/Ambric.fit.html)
- [Ambric.save_trace](reference/Ambric.save_trace.html)
- [Ambric.populate_results](reference/Ambric.populate_results.html)
- [Ambric.plot_national_quarterly_vs_implied](reference/Ambric.plot_national_quarterly_vs_implied.html)
- [Ambric.plot_regional_annual_estimate](reference/Ambric.plot_regional_annual_estimate.html)
- [Ambric.plot_single_region_annual_estimate](reference/Ambric.plot_single_region_annual_estimate.html)
- [Ambric.plot_estimated_regional_quarterly](reference/Ambric.plot_estimated_regional_quarterly.html)
- [Ambric.plot_current_nowcast](reference/Ambric.plot_current_nowcast.html)
- [Ambric.assemble_loadings_data](reference/Ambric.assemble_loadings_data.html)
- [Ambric.plot_loadings_by_region](reference/Ambric.plot_loadings_by_region.html)
- [Ambric.plot_loadings_aggregate](reference/Ambric.plot_loadings_aggregate.html)
- [Ambric.bands_indicator](reference/Ambric.bands_indicator.html)
- [Ambric.point_estimates_q_on_4q](reference/Ambric.point_estimates_q_on_4q.html)
- [Ambric.point_estimates_q_on_q](reference/Ambric.point_estimates_q_on_q.html)
- [Ambric.to_index_q_on_q](reference/Ambric.to_index_q_on_q.html)
- [Ambric.seasonally_adjusted_index_and_growth_by_region](reference/Ambric.seasonally_adjusted_index_and_growth_by_region.html)

#### Functions
> Utility functions

- [bands_indicator_out_of_sample_results](reference/bands_indicator_out_of_sample_results.html): Bands classification of out-of-sample trend q-on-q nowcasts
- [build_ambric_model](reference/build_ambric_model.html): Build the AMBRIC Bayesian state-space model
- [diagnostics.oos_q_on_4q_performance_table](reference/diagnostics.oos_q_on_4q_performance_table.html)
- [diagnostics.plot_out_of_sample_nowcasts](reference/diagnostics.plot_out_of_sample_nowcasts.html)
- [diagnostics.plot_out_of_sample_rmse](reference/diagnostics.plot_out_of_sample_rmse.html)
- [plot_seasonally_adjusted_q_on_q_growth](reference/plot_seasonally_adjusted_q_on_q_growth.html): _summary_
- [prep_data_for_model_run](reference/prep_data_for_model_run.html): Expects a data frame in following format:
- [run_out_of_sample_exercise](reference/run_out_of_sample_exercise.html): Run out-of-sample exercise to evaluate model performance
- [trace_to_series](reference/trace_to_series.html): Convert a trace to the relevant estimated series coming out of the model
- [trend_adjust_out_of_sample_results](reference/trend_adjust_out_of_sample_results.html)
- [utilities.generate_realistic_simulated_data](reference/utilities.generate_realistic_simulated_data.html)
- [utilities.simulate_data](reference/utilities.simulate_data.html)
- [utilities.simulate_real_time_data](reference/utilities.simulate_real_time_data.html)

#### Constants
> Module-level constants and data

- [utilities.OMEGA](reference/utilities.OMEGA.html)