HivePlotData: Hive Plot Data Objects

In HiveR: 2D and 3D Hive Plots for R

Hive Plot Data Objects

Description

In package HiveR, hive plot data sets are stored as an S3 class called HivePlotData, detailed below.

Structure

The structure of a HivePlotData object is a list of 6 elements, some of which are data frames, and an attribute, as follows:

element	(element)	type	description
$nodes		data frame	Data frame of node properties
	$id	int	Node identifier
	$lab	chr	Node label
	$axis	int	Axis to which node is assigned
	$radius	num	Radius (position) of node along the axis
	$size	num	Node size in pixels
	$color	chr	Node color
$edges		data frame	Data frame of edge properties
	$id1	int	Starting node id
	$id2	int	Ending node id
	$weight	num	Width of edge in pixels
	$color	chr	Edge color
$type		chr	Type of hive. See Note.
$desc		chr	Description of data
$axis.cols		chr	Colors for axes
- attr		chr "HivePlotData"	The S3 class designation.

Note

While $edges$id1 and $edges$id2 are defined as the starting and ending nodes of a particular edge, hive plots as currently implemented are not directed graphs (agnostic might be a better word).

HPD$type indicates the type of hive data: If 2D, then the data is intended to be plotted with hivePlot which is a 2D plot with axes radially oriented, and (hopefully) no edges that cross axes. If 3D, then the data is intended to be plotted with plot3dHive which gives an interactive 3D plot, with axes oriented in 3D.

Author(s)

Bryan A. Hanson, DePauw University. [e-mail]

See Also

sumHPD to summarize a HivePlotData object.
chkHPD to verify the integrity of a HivePlotData object.
ranHiveData to generate random HivePlotData objects for testing and demonstration.

Examples

test4 <- ranHiveData(nx = 4)
str(test4)
sumHPD(test4)
plotHive(test4)

HiveR documentation built on Sept. 12, 2024, 7:25 a.m.