network: preparePlotArgs – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

preparePlotArgs

Expand and transform attributes of networks to values appropriate for aguments to plot.network

Description

This is primairly an internal function called by plot.network or by external packages such as ndtv that want to prepare plot.network graphic arguments in a standardized way.

Usage

plotArgs.network(x, argName, argValue, d = NULL, edgetouse = NULL)

Arguments

`x`	a `network` object which is going to be plotted
`argName`	character, the name of `plot.network` graphic parameter
`argValue`	value for the graphic paramter named in `argName` which to be transformed/prepared. For many attributes, if this is a single character vector it will be assumed to be the name of a vertex or edge attribute to be extracted and transformed
`d`	is an edgelist matrix of edge values optionally used by some edge attribute functions
`edgetouse`	numeric vector giving set of edge ids to be used (in case some edges are not being shown) required by some attributes

Details

Given a network object, the name of graphic parameter argument to plot.network and value, it will if necessary transform the value, or extract it from the network, according to the description in plot.network. For some attributes, if the value is the name of a vertex or edge attribute, the appropriate values will be extracted from the network before transformation.

Value

returns a vector with length corresponding to the number of vertices or edges (depending on the paramter type) giving the appropriately prepared values for the parameter type. If the values or specified attribute can not be processed correctly, and Error may occur.

Author(s)

skyebend@uw.edu

Examples

net<-network.initialize(3)
  set.vertex.attribute(net,'color',c('red','green','blue'))
  set.vertex.attribute(net,'charm',1:3)
  # replicate a single colorname value
  plotArgs.network(net,'vertex.col','purple')
  # map the 'color' attribute to color
  plotArgs.network(net,'vertex.col','color')
  # similarly for a numeric attribute ...
  plotArgs.network(net,'vertex.cex',12)
  plotArgs.network(net,'vertex.cex','charm')

network

Classes for Relational Data

v1.16.1

GPL (>= 2)

Authors

Carter T. Butts [aut, cre], David Hunter [ctb], Mark Handcock [ctb], Skye Bender-deMoll [ctb], Jeffrey Horner [ctb], Li Wang [ctb]

Initial release

2020-10-06