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
86
87
88
89
90
91
92
93
94
95
96
97
|
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/print.R
\name{print.igraph}
\alias{print.igraph}
\alias{str.igraph}
\alias{summary.igraph}
\title{Print graphs to the terminal}
\usage{
\method{print}{igraph}(x, full = igraph_opt("print.full"),
graph.attributes = igraph_opt("print.graph.attributes"),
vertex.attributes = igraph_opt("print.vertex.attributes"),
edge.attributes = igraph_opt("print.edge.attributes"), names = TRUE,
max.lines = igraph_opt("auto.print.lines"), ...)
\method{summary}{igraph}(object, ...)
}
\arguments{
\item{x}{The graph to print.}
\item{full}{Logical scalar, whether to print the graph structure itself as
well.}
\item{graph.attributes}{Logical constant, whether to print graph attributes.}
\item{vertex.attributes}{Logical constant, whether to print vertex
attributes.}
\item{edge.attributes}{Logical constant, whether to print edge attributes.}
\item{names}{Logical constant, whether to print symbolic vertex names (ie.
the \code{name} vertex attribute) or vertex ids.}
\item{max.lines}{The maximum number of lines to use. The rest of the
output will be truncated.}
\item{object}{The graph of which the summary will be printed.}
\item{\dots}{Additional agruments.}
}
\value{
All these functions return the graph invisibly.
}
\description{
These functions attempt to print a graph to the terminal in a human readable
form.
}
\details{
\code{summary.igraph} prints the number of vertices, edges and whether the
graph is directed.
\code{str.igraph} prints the same information, and also lists the edges, and
optionally graph, vertex and/or edge attributes.
\code{print.igraph} behaves either as \code{summary.igraph} or
\code{str.igraph} depending on the \code{full} argument. See also the
\sQuote{print.full} igraph option and \code{\link{igraph_opt}}.
The graph summary printed by \code{summary.igraph} (and \code{print.igraph}
and \code{str.igraph}) consists one or more lines. The first line contains
the basic properties of the graph, and the rest contains its attributes.
Here is an example, a small star graph with weighed directed edges and named
vertices: \preformatted{ IGRAPH DNW- 10 9 -- In-star
+ attr: name (g/c), mode (g/c), center (g/n), name (v/c),
weight (e/n) }
The first line always
starts with \code{IGRAPH}, showing you that the object is an igraph graph.
Then a four letter long code string is printed. The first letter
distinguishes between directed (\sQuote{\code{D}}) and undirected
(\sQuote{\code{U}}) graphs. The second letter is \sQuote{\code{N}} for named
graphs, i.e. graphs with the \code{name} vertex attribute set. The third
letter is \sQuote{\code{W}} for weighted graphs, i.e. graphs with the
\code{weight} edge attribute set. The fourth letter is \sQuote{\code{B}} for
bipartite graphs, i.e. for graphs with the \code{type} vertex attribute set.
Then, after two dashes, the name of the graph is printed, if it has one,
i.e. if the \code{name} graph attribute is set.
From the second line, the attributes of the graph are listed, separated by a
comma. After the attribute names, the kind of the attribute -- graph
(\sQuote{\code{g}}), vertex (\sQuote{\code{v}}) or edge (\sQuote{\code{e}})
-- is denoted, and the type of the attribute as well, character
(\sQuote{\code{c}}), numeric (\sQuote{\code{n}}), logical
(\sQuote{\code{l}}), or other (\sQuote{\code{x}}).
As of igraph 0.4 \code{str.igraph} and \code{print.igraph} use the
\code{max.print} option, see \code{\link[base]{options}} for details.
}
\examples{
g <- make_ring(10)
g
summary(g)
}
\author{
Gabor Csardi \email{csardi.gabor@gmail.com}
}
\keyword{graphs}
|
