geom_step ¶

geom_step(
    mapping: FeatureSpec | None = None,
    *,
    data: PlotData | None = None,
    stat: str | None = None,
    position: Position | None = None,
    show_legend: bool | None = None,
    inherit_aes: bool | None = None,
    manual_key: ManualKey | None = None,
    sampling: Sampling | None = None,
    tooltips: Tooltips | None = None,
    direction: Literal["hv", "vh", "mid"] | None = None,
    color_by: str | None = None,
    na_rm: bool | None = None,
    **other_args: Any,
) -> LayerSpec

Connect observations sorted by x with stairs.

Parameters:

mapping (FeatureSpec, default: None ) –

Aesthetic mapping from aes().
data (DataFrame or dict, default: None ) –

Layer data; inherits the plot data when None.
stat (str, default: None ) –

Statistical transformation, by name.
position (str or FeatureSpec, default: None ) –

Position adjustment: a name such as "dodge" or a position_*() spec.
show_legend (bool, default: None ) –

False hides this layer from the legend.
inherit_aes (bool, default: None ) –

False ignores the plot's default mapping for this layer.
manual_key (str or FeatureSpec, default: None ) –

This layer's key in a manual legend: a label, or layer_key().
sampling (str or FeatureSpec, default: None ) –

lets_plot sampling; accepted and ignored, as ggrust draws every row.
tooltips (FeatureSpec or list of str, default: None ) –

Tooltip content: layer_tooltips(), a list of column names, or "none" to disable tooltips (HTML output).
direction ((hv, vh, mid), default: "hv" ) –

"hv" steps along x first, then y; "vh" along y first; "mid" steps halfway between adjacent x values (as ggplot2).
color_by (str, default: None ) –

Aesthetic the color scale applies to ("color" or "fill").
na_rm (bool, default: None ) –

True removes rows with missing values silently; otherwise they are removed with a warning.
**other_args (Any) –

Constant aesthetics such as color="red" or size=2, and the geom's options, e.g. pad=True to draw rows at x = -inf / inf at the panel edges.

Returns:

LayerSpec –

The layer.

Examples:

>>> from ggrust import *
>>> data = {"day": [1, 2, 3, 4, 5], "stock": [10, 7, 7, 4, 9]}
>>> plot = ggplot(data, aes("day", "stock")) + geom_step(direction="mid")