from pandas.plotting import PlotAccessor as _PlotAccessor
from matplotlib.axes import Axes # TODO: remove this in version >= 2.1
from anesthetic.plot import (hist_plot_1d,
kde_plot_1d,
fastkde_plot_1d,
kde_contour_plot_2d,
fastkde_contour_plot_2d,
hist_plot_2d,
scatter_plot_2d)
def _process_docstring(doc):
i = doc.find(' ax')
j = doc.find("See Also")
e = (
" - 'hist_1d' : 1d histogram\n"
" - 'kde_1d' : 1d Kernel Density Estimation plot\n"
" - 'fastkde_1d' : 1d Kernel Density Estimation plot"
" with fastkde package\n"
" - 'hist_2d' : 2d histogram (DataFrame only)\n"
" - 'kde_2d' : 2d Kernel Density Estimation plot"
" (DataFrame only)\n"
" - 'fastkde_2d' : 2d Kernel Density Estimation plot"
" with fastkde package (DataFrame only)\n"
" - 'scatter_2d' : 2d scatter plot (DataFrame only)\n"
)
return doc[:i] + e + doc[i:j]
[docs]
class PlotAccessor(_PlotAccessor):
# noqa: disable=D101
__doc__ = _process_docstring(_PlotAccessor.__doc__)
_common_kinds = _PlotAccessor._common_kinds \
+ ("hist_1d", "kde_1d", "fastkde_1d")
_series_kinds = _PlotAccessor._series_kinds + ()
_dataframe_kinds = _PlotAccessor._dataframe_kinds \
+ ("hist_2d", "kde_2d", "fastkde_2d", "scatter_2d")
_all_kinds = _common_kinds + _series_kinds + _dataframe_kinds
_see_also = """
See Also
--------
:func:`anesthetic.plot.%s`
"""
[docs]
def hist_1d(self, **kwargs): # noqa: D102
return self(kind="hist_1d", **kwargs)
hist_1d.__doc__ = hist_plot_1d.__doc__ + _see_also % "hist_plot_1d"
[docs]
def kde_1d(self, **kwargs): # noqa: D102
return self(kind="kde_1d", **kwargs)
kde_1d.__doc__ = kde_plot_1d.__doc__ + _see_also % "kde_plot_1d"
[docs]
def fastkde_1d(self, **kwargs): # noqa: D102
return self(kind="fastkde_1d", **kwargs)
fastkde_1d.__doc__ = (fastkde_plot_1d.__doc__
+ _see_also % "fastkde_plot_1d")
[docs]
def kde_2d(self, x, y, **kwargs): # noqa: D102
return self(kind="kde_2d", x=x, y=y, **kwargs)
kde_2d.__doc__ = (kde_contour_plot_2d.__doc__
+ _see_also % "kde_contour_plot_2d")
[docs]
def fastkde_2d(self, x, y, **kwargs): # noqa: D102
return self(kind="fastkde_2d", x=x, y=y, **kwargs)
fastkde_2d.__doc__ = (fastkde_contour_plot_2d.__doc__
+ _see_also % "fastkde_contour_plot_2d")
[docs]
def hist_2d(self, x, y, **kwargs): # noqa: D102
return self(kind="hist_2d", x=x, y=y, **kwargs)
hist_2d.__doc__ = (hist_plot_2d.__doc__
+ _see_also % "hist_plot_2d")
[docs]
def scatter_2d(self, x, y, **kwargs): # noqa: D102
return self(kind="scatter_2d", x=x, y=y, **kwargs)
scatter_2d.__doc__ = (scatter_plot_2d.__doc__
+ _see_also % "scatter_plot_2d")
# TODO: remove this in version >= 2.1
def __call__(self, *args, **kwargs):
# noqa: disable=D102
if len(args) > 0 and isinstance(args[0], Axes):
raise ValueError(
"This is anesthetic 1.0 syntax. anesthetic 2.0 now follows "
"pandas in its use of plot.\n"
"samples.plot(ax, x) # anesthetic 1.0\n"
"# anesthetic 2.0\n"
"samples.plot(x=x, ax=ax, kind='kde_1d')\n"
"samples.x.plot.kde_1d(ax=ax)\n"
"samples.plot.kde_1d(x=x, ax=ax)\n\n"
"samples.plot(ax, x, y) # anesthetic 1.0\n"
"# anesthetic 2.0\n"
"samples.plot(x=x, y=y, ax=ax, kind='kde_2d')\n"
"samples.plot.kde_2d(x=x, y=y, ax=ax)"
)
return super().__call__(*args, **kwargs)