igraph 包的参数

igraph 有一些参数（通常）会影响许多函数的行为。这些参数可以通过 igraph_options() 为整个会话设置。

用法

igraph_options(...)

igraph_opt(x, default = NULL)

参数

...

可以仅给出一个列表作为参数，也可以给出任意数量的 name=value 形式的参数，或者不给出任何参数。有关说明，请参见 Value 和 Details 部分。

x

包含选项名称的字符串。

default

如果指定的选项未在选项列表中设置，则返回此值。这有助于检索选项并检查是否已设置，并在未设置时单独进行设置。

值

igraph_options() 返回一个列表，其中包含已更新参数的旧值（不可见）。如果不带任何参数，则返回所有选项的值。

对于 igraph_opt()，返回选项 x 的当前设置值；如果未设置该选项，则返回 NULL。

详细信息

通过调用 igraph_options() 函数设置的参数值将在会话的剩余时间内保持有效，从而影响 igraph 包中其他函数的后续行为（如果这些参数与这些函数相关）。

这提供了自定义 igraph 包功能的可能性，例如通过在包 igraph 的加载钩子中插入对 igraph_options() 的适当调用。

当前使用的参数（按字母顺序排列）

add.params

逻辑标量，指示是否将模型参数添加到各种图构造函数创建的图中。默认值为 TRUE。

add.vertex.names

逻辑标量，指示是否将顶点名称添加到节点级别索引（例如，度数、介数中心性得分等）。默认值为 TRUE。

annotate.plot

逻辑标量，指示是否使用图的名称（name 图属性，如果存在）作为 main，以及顶点和边的数量作为 xlab 来注释 igraph 图。默认为 FALSE。

dend.plot.type

通过 plot_dendrogram() 绘制社区结构树状图时使用的绘图函数。可能的值为 ‘auto’（默认值）、‘phylo’、‘hclust’ 和 ‘dendrogram’。有关详细信息，请参见 plot_dendrogram()。

edge.attr.comb

指定如果修改了图，如何处理边属性。默认值为 list(weight="sum", name="concat", "ignore")。有关详细信息，请参见 attribute.combination()。

print.edge.attributes

逻辑常量，指示打印图时是否打印边属性。默认为 FALSE。

print.full

逻辑标量，指示 print.igraph() 是否也应显示图结构，或者仅显示图的摘要。

print.graph.attributes

逻辑常量，指示打印图时是否打印图属性。默认为 FALSE。

print.vertex.attributes

逻辑常量，指示打印图时是否打印顶点属性。默认为 FALSE。

return.vs.es

返回顶点/边的集合或序列的函数是否应返回正式的顶点/边序列对象。此选项是在 igraph 版本 1.0.0 中引入的，默认值为 TRUE。如果您的包需要旧的行为，您可以在包的 .onLoad 函数中将其设置为 FALSE，而不会影响其他包。

sparsematrices

是否使用 Matrix 包处理（稀疏）矩阵。如果用户使用较大的图，建议使用此选项。

verbose

逻辑常量，指示 igraph 函数是否应输出比最小量更多的信息。例如，如果 TRUE，则某些函数在计算时将使用进度条。默认为 FALSE。

vertex.attr.comb

指定如果修改了图，如何处理顶点属性。默认值为 list(name="concat", "ignore")。有关详细信息，请参见 attribute.combination()。

参见

igraph_options() 类似于 options()，igraph_opt() 类似于 getOption()。

其他 igraph 选项: with_igraph_opt()

作者

Gabor Csardi csardi.gabor@gmail.com

示例

oldval <- igraph_opt("verbose")
igraph_options(verbose = TRUE)
layout_with_kk(make_ring(10))
#> Make graph external pointer.
#> Materializing 'from' vector.
#> Materializing 'to' vector.
#>             [,1]         [,2]
#>  [1,]  1.1483519 -0.003216317
#>  [2,]  0.9291475  0.676715503
#>  [3,]  0.3521535  1.097946790
#>  [4,] -0.3622379  1.099581508
#>  [5,] -0.9411536  0.680995251
#>  [6,] -1.1634674  0.002073742
#>  [7,] -0.9442631 -0.677858079
#>  [8,] -0.3672691 -1.099089365
#>  [9,]  0.3471224 -1.100724083
#> [10,]  0.9260381 -0.682137826
igraph_options(verbose = oldval)

oldval <- igraph_options(verbose = TRUE, sparsematrices = FALSE)
make_ring(10)[]
#> Make graph external pointer.
#> Materializing 'from' vector.
#> Materializing 'to' vector.
#>       [,1] [,2] [,3] [,4] [,5] [,6] [,7] [,8] [,9] [,10]
#>  [1,]    0    1    0    0    0    0    0    0    0     1
#>  [2,]    1    0    1    0    0    0    0    0    0     0
#>  [3,]    0    1    0    1    0    0    0    0    0     0
#>  [4,]    0    0    1    0    1    0    0    0    0     0
#>  [5,]    0    0    0    1    0    1    0    0    0     0
#>  [6,]    0    0    0    0    1    0    1    0    0     0
#>  [7,]    0    0    0    0    0    1    0    1    0     0
#>  [8,]    0    0    0    0    0    0    1    0    1     0
#>  [9,]    0    0    0    0    0    0    0    1    0     1
#> [10,]    1    0    0    0    0    0    0    0    1     0
igraph_options(oldval)
igraph_opt("verbose")
#> [1] FALSE