grassp.pl.remodeling_score

grassp.pl.remodeling_score#

remodeling_score(remodeling_score, show=None, save=None)[source]#

Visualise the distribution of protein remodeling scores.

The function creates a vertical layout containing a histogram (top) and a compact box plot (bottom). It mirrors the visualisation published in Hein et al. 2024 and serves as a quick overview of score distribution and potential outliers.

Parameters:
remodeling_score ndarray

One-dimensional array of remodeling scores, typically generated by remodeling_score().

show bool | None (default: None)

If True (default) the plot is shown and the function returns None.

save bool | str | None (default: None)

Path or boolean forwarded to scanpy.pl._utils.savefig_or_show(). If True, a PNG file named remodeling_score.png is written.

Return type:

Optional[List[Axes]]

Returns:

When show is False, the list [ax_hist, ax_box] is returned to enable further customisation. Otherwise None.