voyagerpy.plotting.plot.configure_violins#

voyagerpy.plotting.plot.configure_violins(violins, cmap: str | None = None, edgecolor: str = '#00000050', alpha: float = 0.7, facecolor: str | None = None) → Tuple[str, float]#

Configure the violins in a violinplot.

Set the facecolor, edgecolor and alpha of the violins in a violinplot.

Parameters:

  • violins (dict) – A dictionary containing the violins in a violinplot. The violins are stored in the key “bodies”.

  • cmap (Optional[str], optional) – The colormap to use for the faces if facecolor is None. If None, use the default colormap, by default None.

  • edgecolor (str, optional) – The edgecolor to use for the violins, by default “#00000050”

  • alpha (float, optional) – The alpha value to use for the violins, by default 0.7

  • facecolor (Optional[str], optional) – The facecolor to use for all violins. If None, use colors from cmap, by default None.

Returns:

The edgecolor and alpha used.

Return type:

Tuple[str, float]