plotnine.geoms.geom_boxplot

class plotnine.geoms.geom_boxplot(*args, **kwargs)[source]

Box and whiskers plot

Usage

geom_boxplot(mapping=None, data=None, stat='boxplot', position='dodge',
             na_rm=False, inherit_aes=True, show_legend=None,
             outlier_stroke=0.5, outlier_alpha=1, varwidth=False, notch=False,
             outlier_shape='o', outlier_color=None, outlier_size=1.5,
             notchwidth=0.5, fatten=2, **kwargs)

Only the mapping and data can be positional, the rest must be keyword arguments. **kwargs can be aesthetics (or parameters) used by the stat.

Parameters:
mapping : aes, optional

Aesthetic mappings created with aes(). If specified and inherit.aes=True, it is combined with the default mapping for the plot. You must supply mapping if there is no plot mapping.

Aesthetic Default value
lower  
middle  
upper  
x  
ymax  
ymin  
alpha 1
color '#333333'
fill 'white'
group  
linetype 'solid'
shape 'o'
size 0.5
weight 1

The bold aesthetics are required.

data : dataframe, optional

The data to be displayed in this layer. If None, the data from from the ggplot() call is used. If specified, it overrides the data from the ggplot() call.

stat : str or stat, optional (default: boxplot)

The statistical transformation to use on the data for this layer. If it is a string, it must be the registered and known to Plotnine.

position : str or position, optional (default: dodge)

Position adjustment. If it is a string, it must be registered and known to Plotnine.

na_rm : bool, optional (default: False)

If False, removes missing values with a warning. If True silently removes missing values.

inherit_aes : bool, optional (default: True)

If False, overrides the default aesthetics.

show_legend : bool or dict, optional (default: None)

Whether this layer should be included in the legends. None the default, includes any aesthetics that are mapped. If a bool, False never includes and True always includes. A dict can be used to exclude specific aesthetis of the layer from showing in the legend. e.g show_legend={'color': False}, any other aesthetic are included by default.

outlier_alpha : float, optional (default: 1)

Transparency of the outlier points.

outlier_color : str or tuple, optional (default: None)

Color of the outlier points.

outlier_shape : str, optional (default: o)

Shape of the outlier points.

outlier_size : float, optional (default: 1.5)

Size of the outlier points.

outlier_stroke : float, optional (default: 0.5)

Stroke-size of the outlier points.

notch : bool, optional (default: False)

Whether the boxes should have a notch.

varwidth : bool, optional (default: False)

If True, boxes are drawn with widths proportional to the square-roots of the number of observations in the groups.

notchwidth : float, optional (default: 0.5)

Width of notch relative to the body width.

fatten : float, optional (default: 2)

A multiplicative factor used to increase the size of the middle bar across the box.