monkeybread.plot.shortest_distances

monkeybread.plot.shortest_distances(distances, expected_distances=None, show=True, **kwargs)

Plots the results of shortest distances calculations in histogram format.

Parameters

• distances (DataFrame) – The shortest distances, as calculated by monkeybread.calc.shortest_distances().

• expected_distances (Union[ndarray, Tuple[ndarray, float, float], None] (default: None)) – The expected distances, with optional threshold and p-value, as calculated by monkeybread.stat.shortest_distances().

• show (Optional[bool] (default: True)) – If true, displays the plot(s). If false, returns the Axes instead.

• kwargs – Keyword arguments to pass to seaborn.histplot().

Return type

Union[Axes, Tuple[Axes, Axes]]

Returns

If show = False, returns nothing. Otherwise, returns a single Axes object or a tuple of two Axes objects if expected_distances is provided.