File: layout_nicely.Rd

package info (click to toggle)
r-cran-igraph 2.1.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 27,044 kB
  • sloc: ansic: 204,981; cpp: 21,711; fortran: 4,090; yacc: 1,229; lex: 519; sh: 52; makefile: 8
file content (85 lines) | stat: -rw-r--r-- 3,367 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/layout.R
\name{layout_nicely}
\alias{layout_nicely}
\alias{nicely}
\title{Choose an appropriate graph layout algorithm automatically}
\usage{
layout_nicely(graph, dim = 2, ...)

nicely(...)
}
\arguments{
\item{graph}{The input graph}

\item{dim}{Dimensions, should be 2 or 3.}

\item{\dots}{For \code{layout_nicely()} the extra arguments are passed to
the real layout function. For \code{nicely()} all argument are passed to
\code{layout_nicely()}.}
}
\value{
A numeric matrix with two or three columns.
}
\description{
This function tries to choose an appropriate graph layout algorithm for the
graph, automatically, based on a simple algorithm. See details below.
}
\details{
\code{layout_nicely()} tries to choose an appropriate layout function for the
supplied graph, and uses that to generate the layout. The current
implementation works like this: \enumerate{ \item If the graph has a graph
attribute called \sQuote{layout}, then this is used. If this attribute is an
R function, then it is called, with the graph and any other extra arguments.
\item Otherwise, if the graph has vertex attributes called \sQuote{x} and
\sQuote{y}, then these are used as coordinates. If the graph has an
additional \sQuote{z} vertex attribute, that is also used.  \item Otherwise,
if the graph is connected and has less than 1000 vertices, the
Fruchterman-Reingold layout is used, by calling \code{layout_with_fr()}.
\item Otherwise the DrL layout is used, \code{layout_with_drl()} is called.  }

In layout algorithm implementations, an argument named \sQuote{weights} is
typically used to specify the weights of the edges if the layout algorithm
supports them. In this case, omitting \sQuote{weights} or setting it to
\code{NULL} will make igraph use the 'weight' edge attribute from the graph
if it is present. However, most layout algorithms do not support non-positive
weights, so \code{layout_nicely()} would fail if you simply called it on
your graph without specifying explicit weights and the weights happened to
include non-positive numbers. We strive to ensure that \code{layout_nicely()}
works out-of-the-box for most graphs, so the rule is that if you omit
\sQuote{weights} or set it to \code{NULL} and \code{layout_nicely()} would
end up calling \code{layout_with_fr()} or \code{layout_with_drl()}, we do not
forward the weights to these functions and issue a warning about this. You
can use \code{weights = NA} to silence the warning.
}
\seealso{
\code{\link[=plot.igraph]{plot.igraph()}}

Other graph layouts: 
\code{\link{add_layout_}()},
\code{\link{component_wise}()},
\code{\link{layout_}()},
\code{\link{layout_as_bipartite}()},
\code{\link{layout_as_star}()},
\code{\link{layout_as_tree}()},
\code{\link{layout_in_circle}()},
\code{\link{layout_on_grid}()},
\code{\link{layout_on_sphere}()},
\code{\link{layout_randomly}()},
\code{\link{layout_with_dh}()},
\code{\link{layout_with_fr}()},
\code{\link{layout_with_gem}()},
\code{\link{layout_with_graphopt}()},
\code{\link{layout_with_kk}()},
\code{\link{layout_with_lgl}()},
\code{\link{layout_with_mds}()},
\code{\link{layout_with_sugiyama}()},
\code{\link{merge_coords}()},
\code{\link{norm_coords}()},
\code{\link{normalize}()}
}
\author{
Gabor Csardi \email{csardi.gabor@gmail.com}
}
\concept{graph layouts}
\keyword{graphs}