plotnine.scales.scale.scale_discrete

class plotnine.scales.scale.scale_discrete(**kwargs)[source]

Base class for all discrete scales

Parameters:
breaks : array_like or callable, optional

Major break points. Alternatively, a callable that takes a tuple of limits and returns a list of breaks. Default is to automatically calculate the breaks.

expand : array_like, optional

Multiplicative and additive expansion constants that determine how the scale is expanded. If specified must of of length 2 or 4. Specifically the the values are of this order:

(mul, add)
(mul_low, add_low, mul_high, add_high)

If not specified, suitable defaults are chosen.

name : str, optional

Name used as the label of the scale. This is what shows up as the axis label or legend title. Suitable defaults are chosen depending on the type of scale.

labels : list or callable, optional

List of str. Labels at the breaks. Alternatively, a callable that takes an array_like of break points as input and returns a list of strings.

limits : array_like, optional

Limits of the scale. Most commonly, these are the min & max values for the scales. For scales that deal with categoricals, these may be a subset or superset of the categories.

palette : callable, optional

Function to map data points onto the scale. Most scales define their own palettes.

aesthetics : list, optional

list of str. Aesthetics covered by the scale. These are defined by each scale and the user should probably not change them. Have fun.

drop : bool

Whether to drop unused categories from the scale

na_translate : bool

If True translate missing values and show them. If False remove missing values. Default value is True

na_value : object

If na_translate=True, what aesthetic value should be assigned to the missing values. This parameter does not apply to position scales where nan is always placed on the right.

train(x, drop=None)[source]

Train scale

Parameters:
x: pd.series| np.array

a column of data to train over

A discrete range is stored in a list
dimension(expand=(0, 0, 0, 0))[source]

The phyical size of the scale, if a position scale Unlike limits, this always returns a numeric vector of length 2

map(x, limits=None)[source]

Return an array-like of x mapped to values from the scales palette

get_breaks(limits=None, strict=True)[source]

Returns a ordered dictionary of the form {break: position}

The form is suitable for use by the guides

e.g. {'fair': 1, 'good': 2, 'very good': 3, 'premium': 4, 'ideal': 5}

get_labels(breaks=None)[source]

Generate labels for the legend/guide breaks

transform_df(df)[source]

Transform dataframe

transform(x)[source]

Transform array|series x