MCPcopy Create free account
hub / github.com/holoviz/hvplot / box

Method box

hvplot/plotting/core.py:936–979  ·  view source on GitHub ↗

The `box` plot gives you a visual idea about the *locality*, *spread* and *skewness* of numerical data through their quartiles. It is also known as *box and whiskers plot*. `box` plots are most useful when grouped by additional dimensions. Reference: https://hvplot

(self, y=None, by=None, **kwds)

Source from the content-addressed store, hash-verified

934 return self(x, y, kind='barh', stacked=stacked, **kwds)
935
936 def box(self, y=None, by=None, **kwds):
937 """
938 The `box` plot gives you a visual idea about the *locality*, *spread* and *skewness* of
939 numerical data through their quartiles. It is also known as *box and whiskers plot*.
940
941 `box` plots are most useful when grouped by additional dimensions.
942
943 Reference: https://hvplot.holoviz.org/ref/api/manual/hvplot.hvPlot.box.html
944
945 Plotting options: https://hvplot.holoviz.org/ref/plotting_options/index.html
946
947 Parameters
948 ----------
949 y : string or sequence
950 Field(s) in the *wide* data to compute distribution from. If none is provided all
951 numerical fields will be used.
952 by : string or sequence
953 Field in the *long* data to group by.
954 kwds : optional
955 Additional keywords arguments are documented in :ref:`plot-options`.
956 Run ``hvplot.help('box')`` for the full method documentation.
957
958 Returns
959 -------
960 :class:`holoviews:holoviews.element.BoxWhisker` / Panel object
961 You can `print` the object to study its composition and run:
962
963 .. code-block::
964
965 import holoviews as hv
966 hv.help(the_holoviews_object)
967
968 to learn more about its parameters and options.
969
970 References
971 ----------
972 - Bokeh: https://docs.bokeh.org/en/latest/docs/examples/topics/stats/boxplot.html
973 - HoloViews: https://holoviews.org/reference/elements/bokeh/BoxWhisker.html
974 - Matplotlib: https://matplotlib.org/stable/plot_types/stats/boxplot_plot.html#sphx-glr-plot-types-stats-boxplot-plot-py
975 - Pandas: https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.boxplot.html
976 - Plotly: https://plotly.com/python/box-plots/
977 - Wiki: https://en.wikipedia.org/wiki/Box_plot
978 """
979 return self(kind='box', x=None, y=y, by=by, **dict(kwds, hover=False))
980
981 def violin(self, y=None, by=None, **kwds):
982 """

Callers

nothing calls this directly

Calls

no outgoing calls

Tested by

no test coverage detected