statsmodels.tsa.x13.x13_arima_analysis¶
-
statsmodels.tsa.x13.x13_arima_analysis(endog, maxorder=
(2, 1), maxdiff=(2, 1), diff=None, exog=None, log=None, outlier=True, trading=False, forecast_periods=None, retspec=False, speconly=False, start=None, freq=None, print_stdout=False, x12path=None, prefer_x13=True, tempdir=None)[source]¶ 对月度或季度数据执行x13-arima分析。
- Parameters:¶
- endogarray_like,
pandas.Series 要建模的序列。最好使用具有 DatetimeIndex 或 PeriodIndex 的 pandas 对象。但是,您可以传递类似数组的对象。如果您的对象没有日期索引,则
start和freq不是可选的。- maxorder
tuple 在模型识别过程中要检查的常规和季节性ARMA多项式的最大阶数。常规多项式的阶数必须大于零且不大于4。季节性多项式的阶数可以是1或2。
- maxdiff
tuple 在自动差分过程中,常规和季节性差分的最大阶数。常规差分的可接受输入为1和2。季节性差分的最大阶数为1。如果指定了
diff,则maxdiff应为None。否则,diff将被忽略。另请参见diff。- diff
tuple 修复常规和季节性差分的阶数。常规差分可以是0、1或2。季节性差分可以是0或1。
maxdiff必须为None,否则diff将被忽略。- exogarray_like
外生变量。
- logbool or
None 如果为 None,则自动确定是否记录系列。如果为 False,则不记录日志。如果为 True,则记录日志。
- outlierbool
是否检测并修正异常值(如果检测到)。
- tradingbool
是否测试交易日效应。
- forecast_periods
int 生成的预测数量。默认值为 None。
- retspecbool
是否返回创建的规范文件。可用于调试。
- speconlybool
是否创建规范文件,然后返回它而不执行分析。可用于调试。
- start
str,datetime 如果
endog的索引中没有日期信息,则必须提供此项。 pandas.DatetimeIndex 接受的任何内容作为开始值。- freq
str 如果
endog的索引中没有日期信息,则必须提供此项。任何 pandas.DatetimeIndex 接受的 freq 值。- print_stdoutbool
X12/X13 的 stdout 被抑制。要打印出来,请将其设置为 True。默认值为 False。
- x12path
strorNone x12 或 x13 二进制文件的路径。如果为 None,程序将尝试在 PATH 中查找 x13as 或 x12a,或者根据 prefer_x13 的值查看 X13PATH 或 X12PATH。
- prefer_x13bool
如果为True,将首先查找x13as,并在找不到时回退到X13PATH环境变量。如果为False,将首先查找x12a,并在找不到时回退到X12PATH环境变量。如果x12path指向X12/X13二进制文件的路径,则不执行任何操作。
- tempdir
str 函数创建临时文件的路径。 如果为 None,文件将创建在默认的临时文件位置。
- endogarray_like,
- Returns:¶
Bunch包含列出属性的对象。
结果 : str X12/X13运行的完整输出。
seasadj : pandas.Series 最终的季节性调整后的
endog。趋势 : pandas.Series 趋势-周期分量
endog。irregular : pandas.Series 最终的
endog的不规则成分。标准输出 : str 由 x12/x13 生成的捕获的标准输出。
spec : str, 可选 如果
retspec为 True,则返回。如果speconly为 True,则仅返回此项。
注释
这是通过创建一个规范文件,将其写入临时目录,在子进程中调用X12/X13,并读取输出目录,在子进程中调用exog12/X13,并读取输出结果来实现的。