File: plot.igraph.Rd

package info (click to toggle)
r-cran-igraph 1.0.1-1%2Bdeb9u1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 18,232 kB
  • sloc: ansic: 173,538; cpp: 19,365; fortran: 4,550; yacc: 1,164; tcl: 931; lex: 484; makefile: 149; sh: 9
file content (82 lines) | stat: -rw-r--r-- 2,987 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/plot.R
\name{plot.igraph}
\alias{plot.graph}
\alias{plot.igraph}
\title{Plotting of graphs}
\usage{
\method{plot}{igraph}(x, axes = FALSE, add = FALSE, xlim = c(-1, 1),
  ylim = c(-1, 1), mark.groups = list(), mark.shape = 1/2,
  mark.col = rainbow(length(mark.groups), alpha = 0.3),
  mark.border = rainbow(length(mark.groups), alpha = 1), mark.expand = 15,
  ...)
}
\arguments{
\item{x}{The graph to plot.}

\item{axes}{Logical, whether to plot axes, defaults to FALSE.}

\item{add}{Logical scalar, whether to add the plot to the current device, or
delete the device's current contents first.}

\item{xlim}{The limits for the horizontal axis, it is unlikely that you want
to modify this.}

\item{ylim}{The limits for the vertical axis, it is unlikely that you want
to modify this.}

\item{mark.groups}{A list of vertex id vectors. It is interpreted as a set
of vertex groups. Each vertex group is highlighted, by plotting a colored
smoothed polygon around and \dQuote{under} it. See the arguments below to
control the look of the polygons.}

\item{mark.shape}{A numeric scalar or vector. Controls the smoothness of the
vertex group marking polygons. This is basically the \sQuote{shape}
parameter of the \code{\link[graphics]{xspline}} function, its possible
values are between -1 and 1. If it is a vector, then a different value is
used for the different vertex groups.}

\item{mark.col}{A scalar or vector giving the colors of marking the
polygons, in any format accepted by \code{\link[graphics]{xspline}}; e.g.
numeric color ids, symbolic color names, or colors in RGB.}

\item{mark.border}{A scalar or vector giving the colors of the borders of
the vertex group marking polygons. If it is \code{NA}, then no border is
drawn.}

\item{mark.expand}{A numeric scalar or vector, the size of the border around
the marked vertex groups. It is in the same units as the vertex sizes. If a
vector is given, then different values are used for the different vertex
groups.}

\item{\dots}{Additional plotting parameters. See \link{igraph.plotting} for
the complete list.}
}
\value{
Returns \code{NULL}, invisibly.
}
\description{
\code{plot.igraph} is able to plot graphs to any R device. It is the
non-interactive companion of the \code{tkplot} function.
}
\details{
One convenient way to plot graphs is to plot with \code{\link{tkplot}}
first, handtune the placement of the vertices, query the coordinates by the
\code{\link{tk_coords}} function and use them with \code{plot} to
plot the graph to any R device.
}
\examples{
g <- ring(10)
\dontrun{plot(g, layout=layout_with_kk, vertex.color="green")}
}
\author{
Gabor Csardi \email{csardi.gabor@gmail.com}
}
\seealso{
\code{\link{layout}} for different layouts,
\code{\link{igraph.plotting}} for the detailed description of the plotting
parameters and \code{\link{tkplot}} and \code{\link{rglplot}} for other
graph plotting functions.
}
\keyword{graphs}