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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
|
# IGraph R package
# Copyright (C) 2005-2012 Gabor Csardi <csardi.gabor@gmail.com>
# 334 Harvard street, Cambridge, MA 02139 USA
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301 USA
#
###################################################################
.igraph.pars <- list("print.vertex.attributes"=FALSE,
"print.edge.attributes"=FALSE,
"print.graph.attributes"=FALSE,
"verbose"=FALSE,
"vertex.attr.comb"=list(name="concat", "ignore"),
"edge.attr.comb"=list(weight="sum", name="concat",
"ignore"),
"sparsematrices"=TRUE,
"nexus.url"="http://nexus.igraph.org",
"add.params"=TRUE,
"add.vertex.names"=TRUE,
"dend.plot.type"="auto",
"print.full"="auto",
"annotate.plot"=FALSE,
"auto.print.lines" = 10,
"return.vs.es" = TRUE
)
igraph.pars.set.verbose <- function(verbose) {
if (is.logical(verbose)) {
.Call("R_igraph_set_verbose", verbose, PACKAGE="igraph")
} else if (is.character(verbose)) {
if (!verbose %in% c("tk", "tkconsole")) {
stop("Unknown 'verbose' value")
}
if (verbose %in% c("tk", "tkconsole")) {
if (!capabilities()[["X11"]]) { stop("X11 not available") }
if (!requireNamespace("tcltk", quietly = TRUE)) {
stop("tcltk package not available")
}
}
.Call("R_igraph_set_verbose", verbose, PACKAGE="igraph")
} else {
stop("'verbose' should be a logical or character scalar")
}
verbose
}
igraph.pars.callbacks <- list("verbose"=igraph.pars.set.verbose)
## This is based on 'sm.options' in the 'sm' package
#' Parameters for the igraph package
#'
#' igraph has some parameters which (usually) affect the behavior of many
#' functions. These can be set for the whole session via \code{igraph_options}.
#'
#' 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}}}. Possible values are \sQuote{auto} (the
#' default), \sQuote{phylo}, \sQuote{hclust} and
#' \sQuote{dendrogram}. See \code{\link{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}} for details on this.}
#' \item{nexus.url}{The base URL of the default Nexus server. See
#' \code{\link{nexus}} for details.}
#' \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}}
#' 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{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. Eg. if \code{TRUE} thne 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}} for details on this.}
#' }
#'
#' @aliases igraph.options igraph_options getIgraphOpt igraph_opt
#' @param \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.
#' @param x A character string holding an option name.
#' @param 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.
#' @return \code{igraph_options} returns a list with the updated values of the
#' parameters. If the argument list is not empty, the returned list is
#' invisible.
#'
#' For \code{igraph_opt}, the current value set for option \code{x}, or
#' \code{NULL} if the option is unset.
#' @author Gabor Csardi \email{csardi.gabor@@gmail.com}
#' @seealso \code{igraph_options} is similar to \code{\link{options}} and
#' \code{igraph_opt} is similar to \code{\link{getOption}}.
#' @keywords graphs
#' @examples
#'
#' oldval <- igraph_opt("verbose")
#' igraph_options(verbose=TRUE)
#' layout_with_kk(make_ring(10))
#' igraph_options(verbose=oldval)
#' #' @export
igraph_options <- function(...) {
if (nargs() == 0) return(.igraph.pars)
current <- .igraph.pars
temp <- list(...)
if (length(temp) == 1 && is.null(names(temp))) {
arg <- temp[[1]]
switch(mode(arg),
list = temp <- arg,
character = return(.igraph.pars[arg]),
stop("invalid argument: ", sQuote(arg)))
}
if (length(temp) == 0) return(current)
n <- names(temp)
if (is.null(n)) stop("options must be given by name")
env <- asNamespace("igraph")
cb <- intersect(names(igraph.pars.callbacks), n)
for (cn in cb) {
temp[[cn]] <- igraph.pars.callbacks[[cn]](temp[[cn]])
}
current <- .igraph.pars # callback might have updated it
current[n] <- temp
assign(".igraph.pars", current, envir = env)
invisible(current)
}
#' @rdname igraph_options
#' @export
igraph_opt <- function(x, default=NULL) {
if (missing(default))
return(igraph_options(x)[[1L]])
if (x %in% names(igraph_options()))
igraph_options(x)[[1L]]
else default
}
|
