neuralib.plot.plot.dotplot

neuralib.plot.plot.dotplot(xlabel, ylabel, values, *, scale='area', max_marker_size=None, size_title=None, size_legend_num=None, size_legend_as_int=True, with_color=False, cmap='Reds', colorbar_title=None, norm=None, cbar_vmin=None, cbar_vmax=None, figure_title=None, figure_output=None, ax=None, **kwargs)[source]

Plot values as dots, with the option also in colormap

Dimension parameters:

X = number of x label

Y = number of y label

Parameters:

  • xlabel (ndarray[tuple[Any, ...], dtype[str_]] | list[str] | tuple[str, ...] | pd.Series | pl.Series) – String arraylike. ArrayLike[str, X]

  • ylabel (ndarray[tuple[Any, ...], dtype[str_]] | list[str] | tuple[str, ...] | pd.Series | pl.Series) – String arraylike. ArrayLike[str, X]

  • values (ndarray) – 2D value array. ArrayLike[str, [X, Y]]

  • scale (Literal['area', 'radius']) – Dot size representation. {‘area’, ‘radius’}

  • max_marker_size (float | None) – Marker size for the max value

  • size_title (str | None) – Size_title in the size legend

  • size_legend_num (int | None) – Number of legend to be shown

  • size_legend_as_int (bool) – Size legend show only Int

  • with_color (bool) – If dot with colormap

  • cmap (str | Colormap) – Colormap

  • colorbar_title (str | None) – Title of the colorbar

  • norm (Normalize | None) – Colorbar Normalize

  • cbar_vmin (float | None) – Value min for the colorbar

  • cbar_vmax (float | None) – Value nax for the colorbar

  • figure_title (str | None) – Figure title

  • figure_output (str | Path | PathLike[str] | None) – Figure save output path

  • ax (Axes | None) – If existing axes Axes

  • kwargs – additional arguments to ax.scatter()