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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/par.R
\name{igraph_options}
\alias{igraph_options}
\alias{igraph_opt}
\title{Parameters for the igraph package}
\usage{
igraph_options(...)
igraph_opt(x, default = NULL)
}
\arguments{
\item{\dots}{A list may be given as the only argument, or any number of
arguments may be in the \code{name=value} form, or no argument at all may be
given. See the Value and Details sections for explanation.}
\item{x}{A character string holding an option name.}
\item{default}{If the specified option is not set in the options list, this
value is returned. This facilitates retrieving an option and checking
whether it is set and setting it separately if not.}
}
\value{
\code{igraph_options()} returns a list with the old values of the
updated parameters, invisibly. Without any arguments, it returns the
values of all options.
For \code{igraph_opt()}, the current value set for option \code{x}, or
\code{NULL} if the option is unset.
}
\description{
igraph has some parameters which (usually) affect the behavior of many
functions. These can be set for the whole session via \code{igraph_options()}.
}
\details{
The parameter values set via a call to the \code{igraph_options()} function
will remain in effect for the rest of the session, affecting the subsequent
behaviour of the other functions of the \code{igraph} package for which the
given parameters are relevant.
This offers the possibility of customizing the functioning of the
\code{igraph} package, for instance by insertions of appropriate calls to
\code{igraph_options()} in a load hook for package \pkg{igraph}.
The currently used parameters in alphabetical order:
\describe{
\item{add.params}{Logical scalar, whether to add model
parameter to the graphs that are created by the various
graph constructors. By default it is \code{TRUE}.}
\item{add.vertex.names}{Logical scalar, whether to add
vertex names to node level indices, like degree, betweenness
scores, etc. By default it is \code{TRUE}.}
\item{annotate.plot}{Logical scalar, whether to annotate igraph
plots with the graph's name (\code{name} graph attribute, if
present) as \code{main}, and with the number of vertices and edges
as \code{xlab}. Defaults to \code{FALSE}.}
\item{dend.plot.type}{The plotting function to use when plotting
community structure dendrograms via
\code{\link[=plot_dendrogram]{plot_dendrogram()}}}. Possible values are \sQuote{auto} (the
default), \sQuote{phylo}, \sQuote{hclust} and
\sQuote{dendrogram}. See \code{\link[=plot_dendrogram]{plot_dendrogram()}} for details.
\item{edge.attr.comb}{Specifies what to do with the edge
attributes if the graph is modified. The default value is
\code{list(weight="sum", name="concat", "ignore")}. See
\code{\link[=attribute.combination]{attribute.combination()}} for details on this.}
\item{print.edge.attributes}{Logical constant, whether to print edge
attributes when printing graphs. Defaults to \code{FALSE}.}
\item{print.full}{Logical scalar, whether \code{\link[=print.igraph]{print.igraph()}}
should show the graph structure as well, or only a summary of the
graph.}
\item{print.graph.attributes}{Logical constant, whether to print
graph attributes when printing graphs. Defaults to \code{FALSE}.}
\item{print.vertex.attributes}{Logical constant, whether to print
vertex attributes when printing graphs. Defaults to \code{FALSE}.}
\item{return.vs.es}{Whether functions that return a set or sequence
of vertices/edges should return formal vertex/edge sequence
objects. This option was introduced in igraph version 1.0.0 and
defaults to TRUE. If your package requires the old behavior,
you can set it to FALSE in the \code{.onLoad} function of
your package, without affecting other packages.}
\item{sparsematrices}{Whether to use the \code{Matrix} package for
(sparse) matrices. It is recommended, if the user works with
larger graphs.}
\item{verbose}{Logical constant, whether igraph functions should
talk more than minimal. E.g. if \code{TRUE} then some functions
will use progress bars while computing. Defaults to \code{FALSE}.}
\item{vertex.attr.comb}{Specifies what to do with the vertex
attributes if the graph is modified. The default value is
\code{list(name="concat", "ignore")} See
\code{\link[=attribute.combination]{attribute.combination()}} for details on this.}
}
}
\examples{
oldval <- igraph_opt("verbose")
igraph_options(verbose = TRUE)
layout_with_kk(make_ring(10))
igraph_options(verbose = oldval)
oldval <- igraph_options(verbose = TRUE, sparsematrices = FALSE)
make_ring(10)[]
igraph_options(oldval)
igraph_opt("verbose")
}
\seealso{
\code{igraph_options()} is similar to \code{\link[=options]{options()}} and
\code{igraph_opt()} is similar to \code{\link[=getOption]{getOption()}}.
Other igraph options:
\code{\link{with_igraph_opt}()}
}
\author{
Gabor Csardi \email{csardi.gabor@gmail.com}
}
\concept{igraph options}
\keyword{graphs}
|
