BreakTest._metadata

BreakTest._metadata()

Header lines: null, restrictions, observations, and what applies.

Trimming is added when the record has a window and Break at when a date was located, so the CUSUM header omits the first and a quiet CUSUM omits both.

Return type:

tuple[tuple[str, str], ...]

Returns:

Label-value pairs in display order.

Example

>>> import numpy as np
>>> rng = np.random.default_rng(0)
>>> y = np.concatenate([rng.standard_normal(100), 2.0 + rng.standard_normal(100)])
>>> sup_wald(y, seed=0)._metadata()[3:]
(('Trimming', '0.15'), ('Break at', '100'))