statsmodels.tsa.statespace.news.NewsResults.summary¶

NewsResults.summary(impact_date=None, impacted_variable=None, update_date=None, updated_variable=None, revision_date=None, revised_variable=None, impacts_groupby='impact date', details_groupby='update date', show_revisions_columns=None, sparsify=True, include_details_tables=None, include_revisions_tables=False, float_format='%.2f')[source]¶

创建描述新闻和影响的摘要表

Parameters:¶

impact_dateint, str, datetime, list, array, or slice, optional

指定要显示的特定影响期的观察索引标签或标签切片。影响日期描述了受影响变量受到新闻影响的期间。如果提供了此参数，影响和详细信息表将仅显示此影响日期或日期。请注意，此参数传递给Pandas的loc访问器，因此它应与模型的索引标签相对应。如果模型是使用列表或numpy数组中的数据创建的，则这些标签将是零索引的观察整数。

impacted_variablestr, list, array, or slice, optional

观测变量的标签或标签切片，指定要显示的特定受影响变量。受影响的变量描述了受到新闻影响的变量。如果您不知道变量的标签，请检查模型实例的endog_names属性。

update_dateint, str, datetime, list, array, or slice, optional

观察索引标签或标签切片，指定要显示的特定更新周期。更新日期描述了生成新闻的新数据点可用的周期。有关这些标签的详细信息，请参阅关于impact_date的注释。

updated_variablestr, list, array, or slice, optional

观测变量的标签或标签切片，指定要显示的特定更新变量。更新变量描述了在更新数据集中新添加的变量，这些变量生成了新闻。如果您不知道变量的标签，请检查模型实例的endog_names属性。

revision_dateint, str, datetime, list, array, or slice, optional

观察指标标签或标签的切片，指定要显示的特定修订期。修订日期描述了数据点被修订的期间。有关这些标签的详细信息，请参见impact_date的注释。

revised_variablestr, list, array, or slice, optional

观测变量的标签或标签切片，指定要显示的特定修订变量。更新后的变量描述了被修订的变量。如果您不知道变量的标签，请检查模型实例的endog_names属性。

impacts_groupby{impact date, impacted date}

影响表中用于分组结果的主要变量。默认是按更新日期分组。

details_groupbystr

“更新日期”、“更新日期”、“影响日期”或“受影响日期”之一。这是在详细信息表中对结果进行分组的主要变量。仅在包含详细信息表时使用。默认情况下，按更新日期分组。

show_revisions_columnsbool, optional

如果设置为False，影响表将不会显示来自数据修订或总影响的内容。默认情况下，如果有任何修订，将显示修订和总计列，否则将隐藏它们。

sparsifybool, optional, default True

将此设置为 False，以便表格在每一行中包含多级索引的每个键。

include_details_tablesbool, optional

如果设置为True，摘要将显示表格，描述特定更新的新闻如何转化为特定影响。这些表格可能会非常长，特别是在有许多更新和多变量模型的情况下。默认情况下，仅对单变量模型显示详细表格。

include_revisions_tablesbool, optional

如果设置为True，摘要将显示描述导致对感兴趣变量产生影响的修订和更新的表格。

float_formatstr, optional

用于将数字转换为字符串的格式化字符串语法。 默认值为‘%.2f’。

Returns:¶

summary_tablesSummary

描述新闻和影响的摘要表。基本表包括：

• 关于样本的常规信息表。

• 描述修订和新闻影响的表格。

• 描述自上次结果集以来数据集中修订的表格（除非include_revisions_tables=False）。

在单变量模型中，或者如果include_details_tables=True，还将包含一个或多个表格，描述特定更新的新闻如何转化为特定影响的具体细节。

另请参阅

summary_impacts

summary_details

summary_revisions

summary_updates