VARXResult._summary_table#

VARXResult._summary_table()[source]#

Structured summary rendered by every display path.

The VAR table with the exogenous count in the metadata and two more notes: that stability, impulse responses and the variance decomposition read the endogenous block only, and that forecasts are conditional on a supplied exogenous path.

Return type:

SummaryTable

Returns:

The SummaryTable behind summary().

Example

>>> import numpy as np
>>> rng = np.random.default_rng(0)
>>> y, x = rng.standard_normal((120, 2)), rng.standard_normal((120, 1))
>>> table = VARX(y, x, order=1, exog_order=1).fit()._summary_table()
>>> table.title, len(table.rows), dict(table.metadata)["Exogenous"]
('VARX(1, 1) Results', 10, '1')
>>> len(table.notes), table.notes[2][:23]
(4, 'Forecasts are condition')