spapros.pl.summary_table

spapros.pl.summary_table(table, summaries='all', color_maps={}, rename_cols={}, rename_rows={}, time_format=[], log_scale=[], color_limits={}, nan_color='lightgrey', threshold_ann={}, show=True, save=False)

Plot table of summary statistics

Parameters:

• table (DataFrame) – Dataframe with set ids in the index and a metric in each column.

• summaries (Union[Literal['all'], ~typing.List[str]]) – List of summary metrics that are plotted.

• color_maps (Dict[str, Colormap]) – Color maps assigned to summary metrics. Use the initial name and not the potential new name given via rename_cols.

• rename_cols (Dict[str, str]) – Rename summary metrics for plot.

• rename_rows (Dict[str, str]) – Rename set ids.

• time_format (List[str]) – Summary names that are formatted to days, hours, mins and secs (seconds are expected as input).

• log_scale (List[str]) – Summary names for which a log scaled colormap is applied.

• color_limits (Dict[str, List[float]]) – For each summary metric optionally provide vmin and vmax for the colormap.

• nan_color (str) – Color for nan values.

• threshold_ann (Dict) – Special annotations for values above/below defined thresholds. E.g. {"time":{"th":1000,"above":True,"ann":"> 1k"}}

• show (bool) – Show the figure.

• save (Union[Literal[False], str]) – Save the plot to path.

Return type:

None