pdendro.make_components¶

pdendro.make_components(Z, *, labels=None, subtrees=(), subtree_colors=None, subtree_colorway=None, default_color=None, direction='vertical', n_segments=8, webgl=False)¶

Create dendrogram components.

Parameters:

Z (array-like of float) – Linkage matrix. Must be formatted as returned by the scipy.cluster.hierarchy.linkage() function.
labels (sequence of str, optional) – Labels of leaf nodes in ascending order of node IDs. If not given, node IDs are used.
subtrees (collection of int, optional) – Root node IDs of subtrees.
subtree_colors (mapping of int to str, optional) – Colors of subtrees. The key is the root node ID of a subtree, and the value is a color. This takes precedence over subtree_colorway.
subtree_colorway (sequence of str, optional) – Colorway of subtrees. Must not be empty. Colors are assigned to subtrees in descending order of their root node IDs. If the number of colors is insufficient, the sequence is cyclically extended.
default_color (str, optional) – Default color of a dendrogram.
direction ({'vertical', 'horizontal', 'radial'}, optional) – Direction of a dendrogram.
n_segments (int, optional) – Number of link segments between a node and a corner point on the path to its child node. Used only if direction is 'radial'.
webgl (bool, optional) – If True, create components for WebGL.

Returns:

node_trace (plotly.basedatatypes.BaseTraceType) – Trace object for nodes. plotly.graph_objects.Scatter object if direction is 'vertical' or 'horizontal' and webgl is False; plotly.graph_objects.Scattergl object if direction is 'vertical' or 'horizontal' and webgl is True; plotly.graph_objects.Scatterpolar object if direction is 'radial' and webgl is False; plotly.graph_objects.Scatterpolargl object if direction is 'radial' and webgl is True.
link_traces (dict of int to plotly.basedatatypes.BaseTraceType) – Trace objects for links. The key is the root node ID of a dendrogram or its subtree. The value is links: plotly.graph_objects.Scatter object if direction is 'vertical' or 'horizontal' and webgl is False; plotly.graph_objects.Scattergl object if direction is 'vertical' or 'horizontal' and webgl is True; plotly.graph_objects.Scatterpolar object if direction is 'radial' and webgl is False; plotly.graph_objects.Scatterpolargl object if direction is 'radial' and webgl is True.
axis1 (plotly.basedatatypes.BaseLayoutHierarchyType) – Layout object for the first axis. plotly.graph_objects.layout.XAxis object if direction is 'vertical' or 'horizontal'; plotly.graph_objects.layout.polar.RadialAxis object if direction is 'radial'.
axis2 (plotly.basedatatypes.BaseLayoutHierarchyType) – Layout object for the second axis. plotly.graph_objects.layout.YAxis object if direction is 'vertical' or 'horizontal'; plotly.graph_objects.layout.polar.AngularAxis object if direction is 'radial'.