plotnine.stats.stat_function

class plotnine.stats.stat_function(*args, **kwargs)[source]

Superimpose a function onto a plot

Usage

stat_function(mapping=None, data=None, geom='path', position='identity',
              na_rm=False, fun=None, args=None, n=101, xlim=None, **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:
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
y 'stat(y)'

The bold aesthetics are required.

Options for computed aesthetics

'x'  # x points are which the function is evaluated
'y'  # Points evaluated at x
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.

geom : str or stat, optional (default: path)

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: identity)

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.

fun : function

Function to evaluate.

n : int, optional (default: 101)

Number of points at which to evaluate the function.

xlim : tuple (default: None)

x limits for the range. The default depends on the x aesthetic. There is not an x aesthetic then the xlim must be provided.

args : tuple or dict (default: None)

Arguments to pass to fun.