voyagerpy.plotting.simple_violinplot#

voyagerpy.plotting.simple_violinplot(ax: Axes, df: DataFrame, y: str | int, cmap: str | None = None, scatter_points: bool = True, jitter: bool = False, **kwargs) → Axes#

Draw a simple violinplot.

Parameters:

  • ax (Axes) – The axis to draw the violinplot on.

  • df (DataFrame) – The dataframe containing the data to plot.

  • y (Union[str, int]) – The column to plot.

  • cmap (Optional[str], optional) – The colormap to use for the violins, by default None.

  • scatter_points (bool, optional) – Draw points along the center of the violins, with the values from y, by default True.

  • jitter (bool, optional) – Draw the points randomly distributed along the x-axis within the violin, by default False.

  • **kwargs –

    Keyword arguments to pass to matplotlib.axes.Axes.violinplot(). Additionally, these keys are used:

    • x_label: The label for the x-axis, by default None.

    • y_label: The label for the y-axis, by default y.

    • legend: If True, show a legend, by default False.

Returns:

The axis containing the violinplot.

Return type:

Axes