R: Parameters for the igraph package

igraph options {igraph}

R Documentation

Parameters for the igraph package

Description

igraph has some parameters which (usually) affect the behavior of many functions. These can be set for the whole session via igraph.options.

Usage

igraph.options(...)
getIgraphOpt(x, default = NULL)
igraph.par(parid, parvalue = NULL)

Arguments

`...`	A list may be given as the only argument, or any number of arguments may be in the `name=value` form, or no argument at all may be given. See the Value and Details sections for explanation.
`x`	A character string holding an option name.
`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.
`parid`	The name of the parameter. See the currently used parameters below.
`parvalue`	The new value of the parameter. If `NULL` then the current value of the parameter is listed.

Details

From igraph version 0.6, igraph.par is deprecated. Please use the more flexible igraph.options and getIgraphOpt functions instead.

The parameter values set via a call to the igraph.options function will remain in effect for the rest of the session, affecting the subsequent behaviour of the other functions of the igraph package for which the given parameters are relevant.

This offers the possibility of customizing the functioning of the igraph package, for instance by insertions of appropriate calls to igraph.options in a load hook for package igraph.

The currently used parameters in alphabetical order:

add.params: Logical scalar, whether to add model parameter to the graphs that are created by the various graph constructors. By default it is TRUE.
add.vertex.names: Logical scalar, whether to add vertex names to node level indices, like degree, betweenness scores, etc. By default it is TRUE.
dend.plot.type: The plotting function to use when plotting community structure dendrograms via dendPlot

. Possible values are ‘auto’ (the default), ‘phylo’, ‘hclust’ and ‘dendrogram’. See dendPlot for details.

edge.attr.comb: Specifies what to do with the edge attributes if the graph is modified. The default value is list(weight="sum", name="concat", "ignore"). See attribute.combination for details on this.
nexus.url: The base URL of the default Nexus server. See nexus for details.
print.edge.attributes: Logical constant, whether to print edge attributes when printing graphs. Defaults to FALSE.
print.full: Logical scalar, whether print.igraph should show the graph structure as well, or only a summary of the graph.
print.graph.attributes: Logical constant, whether to print graph attributes when printing graphs. Defaults to FALSE.
print.vertex.attributes: Logical constant, whether to print vertex attributes when printing graphs. Defaults to FALSE.
sparsematrices: Whether to use the Matrix package for (sparse) matrices. It is recommended, if the user works with larger graphs.
verbose: Logical constant, whether igraph functions should talk more than minimal. Eg. if TRUE thne some functions will use progress bars while computing. Defaults to FALSE.
vertex.attr.comb: Specifies what to do with the vertex attributes if the graph is modified. The default value is list(name="concat", "ignore") See attribute.combination for details on this.

Value

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 getIgraphOpt, the current value set for option x, or NULL if the option is unset.

If parvalue is NULL then igraph.par returns the current value of the parameter. Otherwise the new value of the parameter is returned invisibly.

Author(s)

Gabor Csardi csardi.gabor@gmail.com

Examples

oldval <- getIgraphOpt("verbose")
igraph.options(verbose=TRUE)
layout.kamada.kawai(graph.ring(10))
igraph.options(verbose=oldval)

[Package igraph version 0.6.5-1 Index]