manipAxis: Modify the Display of Axes and Nodes in a Hive Plot

Description Usage Arguments Details Value Author(s) Examples

View source: R/manipAxis.R

Description

This function modifies various aspects of a HivePlotData object. A typical use is to convert the radii from the native/absolute values in the original object to either a normalized value (0...1) or to a ranked value. The order of nodes on an axis can also be inverted, and an axis can be pruned (removed) from the HivePlotData object.

Usage

1
manipAxis(HPD, method, action = NULL, ...)

Arguments

HPD

An object of S3 class HivePlotData.

method

One of c("rank", "norm", "scale", "invert", "ranknorm", "prune", "offset", "stretch") giving the type of modification to be made.

action

For method = c("scale", "invert", "offset", "stretch"), a numeric vector of the same length as the number of axes.

...

Arguments to be passed downstream. Needed in this case for when plotHive has arguments for grid that get laundered through manipAxis

Details

The rank method uses ties.method = "first" so that each node gets a unique radius. For pruning, the nodes and edges are removed and then the remaining axes are renumbered to start from one. Exercise caution!

For "scale" node radii will be multiplied by the corresponding value in this argument. For "invert" a value of -1 will cause the corresponding axis to be inverted. For "prune", a single value specifying the axis to be pruned should be given. For "offset" the values in "action" will be subtracted from the node radii. For "stretch", node radii will first be offset so that the minimum value is zero, then multiplied by the values in "action" to stretch the axis. Depending upon the desired effect, one might use "stretch" followed by "offset" or perhaps other combinations.

Value

A modified HivePlotData object.

Author(s)

Bryan A. Hanson, DePauw University. [email protected]

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
data(HEC)
# The first 3 examples take advantage of the argument '...'
# in plotHive, which passes action through to manipAxis on the fly.
# For this particular data, norm and absolute scaling appear the same.

plotHive(HEC, bkgnd = "white") # default is absolute positioning of nodes
plotHive(HEC, method = "rank", bkgnd = "white")
plotHive(HEC, method = "norm", bkgnd = "white")

# In these examples, we'll explicitly use manipAxis and then plot
# in a separate step.  This is because trying to plot on the fly in
# these cases will result in absolute scaling (which we do use here,
# but one might not want to be forced to do so).

HEC2 <- manipAxis(HEC, method = "invert", action = c(-1, 1))
plotHive(HEC2, bkgnd = "white")
HEC3 <- manipAxis(HEC, method = "stretch", action = c(2,3))
plotHive(HEC3, bkgnd = "white")
HEC4 <- manipAxis(HEC, method = "offset", action = c(0, 1.5))
plotHive(HEC4, bkgnd = "white")

HiveR documentation built on July 28, 2017, 9:01 a.m.