R: Apply a dendrogram layout to layout_igraph

layout_igraph_dendrogram {ggraph} | R Documentation

## Apply a dendrogram layout to layout_igraph

### Description

This layout mimicks the `layout_as_tree` algorithm supplied by igraph, but puts all leaves at 0 and builds it up from there, instead of starting from the root and building it from there. The height of branch points are related to the maximum distance to an edge from the branch node.

### Usage

    layout_igraph_dendrogram(graph, circular = FALSE, offset = pi/2,
      direction = "out")

### Arguments

`graph` | An igraph object
`circular` | Logical. Should the layout be transformed to a circular representation. Defaults to `FALSE`.
`offset` | If `circular = TRUE`, where should it begin. Defaults to `pi/2` which is equivalent to 12 o'clock.
`direction` | The direction to the leaves. Defaults to 'out'

### Value

A data.frame with the columns `x`, `y`, `circular` and `leaf` as well as any information stored as vertex attributes on the igraph object.

### Note

This function is not intended to be used directly but by setting `layout = 'dendrogram'` in `create_layout`

### See Also

Other layout_igraph_*: `layout_igraph_auto`, `layout_igraph_circlepack`, `layout_igraph_hive`, `layout_igraph_linear`, `layout_igraph_manual`, `layout_igraph_partition`, `layout_igraph_treemap`

[Package ggraph version 1.0.0 Index]