Accessors for applying essential igraph methods to modify attributes of GraphSpace objects.
Source:R/gspace-methods.R
GraphSpace-accessors.RdAccess and modify individual slots of a GraphSpace object. Selected 'igraph' methods are applied to the 'graph' slot and propagated to downstream components.
Usage
# S4 method for class 'GraphSpace'
gs_nodes(x)
# S4 method for class 'GraphSpace'
gs_edges(x)
# S4 method for class 'GraphSpace'
gs_graph(x)
# S4 method for class 'GraphSpace'
gs_vcount(x)
# S4 method for class 'GraphSpace'
gs_ecount(x)
# S4 method for class 'GraphSpace'
names(x)
# S4 method for class 'GraphSpace'
names(x) <- value
# S4 method for class 'GraphSpace'
gs_vertex_attr(x, name, ...)
# S4 method for class 'GraphSpace'
gs_vertex_attr(x, name, ...) <- value
# S4 method for class 'GraphSpace'
gs_edge_attr(x, name, ...)
# S4 method for class 'GraphSpace'
gs_edge_attr(x, name, ...) <- value
# S4 method for class 'GraphSpace'
x$name
# S4 method for class 'GraphSpace'
x$name <- value
# S3 method for class 'GraphSpace'
as.igraph(x, ...)Arguments
- x
A GraphSpace class object
- value
The new value of the attribute.
- name
Name of the attribute.
- ...
Additional arguments passed to igraph and extraction methods.
Value
Updated GraphSpace object.
Examples
library(RGraphSpace)
library(igraph)
#>
#> Attaching package: ‘igraph’
#> The following objects are masked from ‘package:stats’:
#>
#> decompose, spectrum
#> The following object is masked from ‘package:base’:
#>
#> union
# Load a demo igraph
data('gtoy1', package = 'RGraphSpace')
# Create a new GraphSpace object
gs <- GraphSpace(gtoy1)
#> Validating the 'igraph' object...
#> Creating a 'GraphSpace' object...
#--- Usage of GraphSpace attribute accessors:
# Get a data frame with nodes for plotting methods
gs_nodes(gs)
#> vertex x y name nodeLabel nodeLabelSize nodeLabelColor nodeShape nodeSize
#> n1 1 0 0 n1 V1 8 black 21 8
#> n2 2 2 0 n2 V2 8 black 22 5
#> n3 3 -2 2 n3 V3 8 black 23 5
#> n4 4 -4 -4 n4 V4 8 black 24 10
#> n5 5 -8 0 n5 <NA> 8 black 25 5
#> nodeColor nodeLineWidth nodeLineColor nodeAlpha
#> n1 red 1 grey20 1
#> n2 #00ad39 1 grey20 1
#> n3 grey80 1 grey20 1
#> n4 lightblue 1 grey20 1
#> n5 cyan 1 grey20 1
# Get a data frame with edges for plotting methods
gs_edges(gs)
#> x y xend yend offset_start offset_end vertex1 vertex2 name1 name2
#> 1 0 0 2 0 0 5 1 2 n1 n2
#> 2 0 0 -2 2 0 5 1 3 n1 n3
#> 3 0 0 -4 -4 0 10 1 4 n1 n4
#> 4 0 0 -8 0 0 5 1 5 n1 n5
#> edgeLineType edgeLineColor edgeLineWidth arrowType edgeAlpha
#> 1 solid red 0.8 1 1
#> 2 11 green 0.8 1 1
#> 3 dashed blue 0.8 1 1
#> 4 2124 black 0.8 1 1
# Get vertex count
gs_vcount(gs)
#> [1] 5
# Get edge count
gs_ecount(gs)
#> [1] 4
# Get vertex names
names(gs)
#> [1] "n1" "n2" "n3" "n4" "n5"
# Access all vertex attributes
gs_vertex_attr(gs)
#> $x
#> [1] 0 2 -2 -4 -8
#>
#> $y
#> [1] 0 0 2 -4 0
#>
#> $name
#> [1] "n1" "n2" "n3" "n4" "n5"
#>
#> $nodeLabel
#> [1] "V1" "V2" "V3" "V4" NA
#>
#> $nodeLabelSize
#> [1] 8 8 8 8 8
#>
#> $nodeLabelColor
#> [1] "black" "black" "black" "black" "black"
#>
#> $nodeShape
#> [1] 21 22 23 24 25
#>
#> $nodeSize
#> [1] 8 5 5 10 5
#>
#> $nodeColor
#> [1] "red" "#00ad39" "grey80" "lightblue" "cyan"
#>
#> $nodeLineWidth
#> [1] 1 1 1 1 1
#>
#> $nodeLineColor
#> [1] "grey20" "grey20" "grey20" "grey20" "grey20"
#>
#> $nodeAlpha
#> [1] 1 1 1 1 1
#>
# Access a specific vertex attribute
gs_vertex_attr(gs, "nodeLabel")
#> n1 n2 n3 n4 n5
#> "V1" "V2" "V3" "V4" NA
# Modify a single value within a vertex attribute
gs_vertex_attr(gs, "nodeSize")["n1"] <- 10
# Replace an entire vertex attribute
gs_vertex_attr(gs, "nodeSize") <- 10
# Alternative syntax using `$` accessor
gs_vertex_attr(gs)$nodeSize <- 10
# Access a specific edge attribute
gs_edge_attr(gs, "edgeLineColor")
#> [1] "red" "green" "blue" "black"
# Replace an entire edge attribute
gs_edge_attr(gs, "edgeLineWidth") <- 1
# Alternative syntax using `$` for edge attributes
gs_edge_attr(gs)$edgeLineWidth <- 3