igraph options

0th

Percentile

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 igraph.options.

Keywords
graphs
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: [object Object],[object Object],[object Object],. Possible values are auto (the default), phylo, hclust and dendrogram. See dendPlot for details.,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

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.

See Also

igraph.options is similar to options and getIgraphOpt is similar to getOption.

Aliases
  • igraph.options
  • getIgraphOpt
  • igraph.par
Examples
oldval <- getIgraphOpt("verbose")
igraph.options(verbose=TRUE)
layout.kamada.kawai(graph.ring(10))
igraph.options(verbose=oldval)
Documentation reproduced from package igraph, version 0.6.5-2, License: GPL (>= 2)

Community examples

violet.hj@gmail.com at Jul 20, 2018 igraph v0.7.1

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