guide_axis_dendro ¶

guide_axis_dendro(
    *,
    space: Number | None = None,
    side: Literal["axis", "opposite"] | None = None,
    type: Literal | None = None,
    title: str | None = None,
) -> FeatureSpec

Axis guide that draws the scale's tree beside the axis (R legendry).

Parameters:

space (float, default: 40 ) –

Pixels from the leaves to the root.
side ((axis, opposite), default: "axis" ) –

"axis": past the tick labels, root outward (legendry). "opposite": across the panel (top for x, right for y), without labels (scanpy).
type ((rectangle, triangle), default: "rectangle" ) –

Elbow links, or straight lines.
title (str, default: None ) –

Axis title (as the scale's name).

Returns:

FeatureSpec –

Guide specification for scale_*_dendro(guide=...).

Raises:

SpecError –

If side or type is unknown.
UnsupportedValueError –

If space is not a number of 0 or more.

Examples:

>>> from ggrust import *
>>> guide = guide_axis_dendro(side="opposite", space=60)