shapiq.game_theory.is_index_aggregated

shapiq.game_theory.is_index_aggregated(index)

Checks if the given index is an aggregated interaction index as denoted by a -.

Parameters:

index (str) – The interaction index.

Return type:

bool

Returns:

True if the index is an aggregated interaction index, False otherwise.

Examples

>>> is_index_aggregated("k-SII")
True
>>> is_index_aggregated("SII")
False
>>> is_index_aggregated("SV")
False
>>> is_index_aggregated("k-FSII")
True