Skip to content

Commit

Permalink
Update ggraph docs with unlinked layout
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasp85 committed Jan 14, 2024
1 parent a910fc7 commit fa585f2
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 2 deletions.
26 changes: 26 additions & 0 deletions R/ggraph.R
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,32 @@
#' \item{`cactustree`}{Positions nodes as circles on the periphery of their
#' parent circle. See [layout_tbl_graph_cactustree()] for further
#' details}
#' \item{`backbone`}{Layout optimised for highly connected small-world graphs
#' such as social networks. See [layout_tbl_graph_backbone()] for further
#' details}
#' \item{`centrality`}{Place nodes around origin based on their centrality.
#' See [layout_tbl_graph_centrality()] for further
#' details}
#' \item{`eigen`}{Spectral layout based on the eigenvector of a matrix
#' representation of the graph. See [layout_tbl_graph_eigen()] for further
#' details}
#' \item{`fabric`}{Draw nodes as horizontal lines and connect them with
#' vertical lines if an edge exists between them. See
#' [layout_tbl_graph_fabric()] for further
#' details}
#' \item{`focus`}{Place nodes around a focus node based on their distance to
#' that node. See [layout_tbl_graph_focus()] for further
#' details}
#' \item{`pmds`}{Layout based on multidimensional scaling of a set of pivot
#' nodes, allowing MDS layout to be used on larger graphs. See
#' [layout_tbl_graph_pmds()] for further
#' details}
#' \item{`stress`}{Layout based on stress minimisation with better stability
#' than Kamada-Kawai layout. See [layout_tbl_graph_stress()] for further
#' details}
#' \item{`unrooted`}{Draws unrooted trees based on equal angle with optional
#' equal daylight modification. See [layout_tbl_graph_unrooted()] for further
#' details}
#' }
#'
#' Alternatively a matrix or a data.frame can be provided to the `layout`
Expand Down
2 changes: 1 addition & 1 deletion R/layout_unrooted.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#' leafs out on the plane without putting any special emphasis on a particular
#' node using an unrooted layout. The standard algorithm is the equal angle
#' algorithm, but it can struggle with optimising the leaf distribution for
#' large trees trees with very uneven branch length. The equal daylight
#' large trees with very uneven branch length. The equal daylight
#' algorithm modifies the output of the equal angle algorithm to better disperse
#' the leaves, at the cost of higher computational cost and the possibility of
#' edge crossings for very large unbalanced trees. For standard sized trees the
Expand Down
29 changes: 29 additions & 0 deletions man/ggraph.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/layout_tbl_graph_unrooted.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fa585f2

Please sign in to comment.