scale_x_dendro ¶

scale_x_dendro(
    clust: ClusterTree,
    name: str | None = None,
    *,
    breaks: Breaks | None = None,
    labels: Labels | None = None,
    expand: Sequence[Number] | None = None,
    reverse: bool | None = None,
    format: str | None = None,
    guide: FeatureSpec | str | None = None,
    position: AxisPosition | None = None,
) -> FeatureSpec

Discrete x scale ordered by a clustering tree, drawn below the axis (legendry).

The axis levels are the tree's leaves in its order; every value mapped to x must be a leaf. The tree is drawn by guide (default guide_axis_dendro()).

Parameters:

clust (ClusterTree) –

The tree, from :func:hclust.
name (str, default: None ) –

Axis title.
breaks (optional, default: None ) –

As scale_x_discrete().
labels (optional, default: None ) –

As scale_x_discrete().
expand (optional, default: None ) –

As scale_x_discrete().
format (optional, default: None ) –

As scale_x_discrete().
reverse (bool, default: False ) –

Reverse the leaf order (the tree flips with it).
guide (FeatureSpec or axis_dendro, default: None ) –

guide_axis_dendro(...) options.
position (str, default: None ) –

Side of the axis, as in scale_x_discrete() / scale_y_discrete(); a side="axis" tree follows the axis there.

Returns:

FeatureSpec –

Scale specification.

Raises:

UnsupportedValueError –

If clust is not an :class:ClusterTree or guide is another guide.

Examples:

>>> from ggrust import *
>>> frame = {"city": ["Oslo", "Rome", "Cairo"], "jan": [-4.0, 8.0, 14.0]}
>>> tree = hclust(frame, labels="city")
>>> plot = ggplot(frame, aes("city", "jan")) + geom_bar(stat="identity")
>>> plot = plot + scale_x_dendro(tree)