incline.moving_average_decompose

incline.moving_average_decompose(df, value_column='value', period=None)[source]

Classical decomposition by a centered moving average.

Parameters:

  • df (DataFrame) – Time series data.

  • value_column (str) – Column holding the values.

  • period (int | None) – Cycle length. Detected when None.

Returns:

The frame plus DECOMPOSITION_COLUMNS.

Raises:

ValueError – If the detected or supplied period cannot support the decomposition.

Return type:

DataFrame