plotnine.stats.stat_bindot¶

class plotnine.stats.stat_bindot(mapping: Aes | None = None, data: DataLike | None = None, **kwargs: Any)[source]¶

Binning for a dot plot

Usage

stat_bindot(mapping=None, data=None, geom='dotplot', position='identity',
            na_rm=False, binpositions='bygroup', drop=False, binwidth=None,
            origin=None, bins=None, method='dotdensity', breaks=None,
            width=0.9, binaxis='x', right=True, **kwargs)

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

Parameters:

mappingaes, 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
x
y	`after_stat('count')`

The bold aesthetics are required.

Options for computed aesthetics

'count'    # number of points in bin
'density'  # density of points in bin, scaled to integrate to 1
'ncount'   # count, scaled to maximum of 1
'ndensity' # density, scaled to maximum of 1

datadataframe, 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.

geomstr or geom, optional (default: geom_dotplot)

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.

positionstr or position, optional (default: position_identity)

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

na_rmbool, optional (default: False)

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

binsint, optional (default: None)

Number of bins. Overridden by binwidth. If None, a number is computed using the freedman-diaconis method.

binwidthfloat, optional (default: None)

When method='dotdensity', this specifies the maximum binwidth. When method='histodot', this specifies the binwidth. This supercedes the bins.

originfloat, optional (default: None)

When method='histodot', origin of the first bin.

widthfloat, optional (default: 0.9)

When binaxis='y', the spacing of the dotstacks for dodging.

binaxisstr, optional (default: x)

Axis to bin along. Either 'x' or 'y'

methodstr, optional (default: dotdensity)

One of dotdensity or histodot. These provide either of dot-density binning or fixed bin widths.

binpositionsstr, optional (default: bygroup)

Position of the bins when method='dotdensity'. The value is one of:

'bygroup'  # positions of the bins for each group are
           # determined separately.
'all'      # positions of the bins are determined with all
           # data taken together. This aligns the dots
           # stacks across multiple groups.

dropbool, optional (default: False)

If True, remove all bins with zero counts.

rightbool, optional (default: True)

When method='histodot', True means include right edge of the bins and if False the left edge is included.

breaksarray-like, optional (default: None)

Bin boundaries for method='histodot'. This supercedes the binwidth and bins.