nicetoolbox.evaluation.data.summary.summarize_with_group_by

nicetoolbox.evaluation.data.summary.summarize_with_group_by(arrays: list[nicetoolbox.evaluation.data.input_loader.LoadedArray], group_by: GroupBySpec, agg: AggSpec) → DataFrame

Build a summary DataFrame from frame-level arrays, grouped by specified dimensions.

Meta-level fields are always iterated; axes-level fields are iterated only when listed in group_by.

Parameters:

• arrays – Frame-level LoadedArray instances to summarize.

• group_by – User-specified grouping dimensions applied on top of mandatory always-iterate fields.

• agg – Aggregation specification mapping output column names to functions.

Returns:

Summary DataFrame with one row per group and one column per aggregation function, or an empty DataFrame if arrays is empty.