renderInfo-class {graph}R Documentation

Class "renderInfo"

Description

A container class to manage graph rendering attributes.

Objects from the Class

Objects can be created by calls of the form new("renderInfo") or by using the initializer .renderInfoPrototype.

Slots

nodes:
Named list of attributes specific to nodes.
edges:
Named list of attributes specific to edges.
pars:
List of default rendering attributes with two items nodes and edges
Each item of nodes and edges can take arbitrary vectors, the only restriction is that they have to be of either length 1 or length equal to the number of nodes or edges, respectively.

pars can take arbitrary skalars for both edges and nodes.

Methods

The following are functions rather than methods and build the API to control the graphical output of a graph when it is plotted using renderGraph. Please see graphRendering for more details.

nodeRenderInfo, nodeRenderInfo<-
getter and setter for items of slot nodes
edgeRenderInfo, edgeRenderInfo<-
getter and setter for items of slot edges
graphRenderInfo, graphRenderInfo<-
getter and setter for items of slot graph
parRenderInfo, parRenderInfo<-
getter and setter for items of slot pars
The getters all take two arguments: g is a graph object and name is a character giving the name of one of the item in the respective slot. When name is missing this will give you the whole list.

The setters are a bit more complex: nodeRenderInfo<- and edgeRenderInfo<- can take

named list of named vectors
where the names have to match the node or edge names. Items in the vector that don't match a valid edge or node name will be silently ignored. For undirected edges the order of head nodes and tail nodes in edge names is ignored, i.e. a~b is equivalent to code{b~a}
named list of skalars
which will set all the attribute for all edges or nodes in the graph
parRenderInfo<-{will only take a list with items nodes, edges and graph. The content of these list items can be arbitrary named vectors.} parRenderInfo<-{takes an arbitrary list}

Author(s)

Deepayan Sarkar, Florian Hahne

Examples

g <- randomGraph(letters[1:4], 1:3, p=0.8)
nodeRenderInfo(g) <- list(fill=c("a"="red", "b"="green"))
edgeRenderInfo(g) <- list(lwd=3)
edgeRenderInfo(g) <- list(lty=3, col="red")
parRenderInfo(g) <- list(edges=list(lwd=2, lty="dashed"),
nodes=list(col="gray", fill="gray"))
nodeRenderInfo(g)
edgeRenderInfo(g, "lwd")
edgeRenderInfo(g, c("lwd", "col"))
parRenderInfo(g)

[Package graph version 1.20.0 Index]