zenplots (version 1.0.0)

zenpath: Construct a Path of Indices to Order Variables

Description

Constructing zenpaths and tools for extracting, connecting and displaying pairs, as well as grouping and indexing data structures.

Usage

zenpath(x, pairs = NULL,
        method = c("front.loaded", "back.loaded",
                   "balanced", "eulerian.cross", 
                   "greedy.weighted", "strictly.weighted"),
        decreasing = TRUE)

Arguments

x

method

"front.loaded":

single integer >= 1.

"back.loaded":

as for method = "front.loaded".

"balanced":

as for method = "front.loaded".

"eulerian.cross":

two integers >= 1 representing the group sizes.

"greedy.weighted":

numeric weight vector (or matrix or distance matrix).

"strictly.weighted":

as for method = "greedy.weighted".

pairs

a two-column matrix containing (row-wise) the pairs of connected variables to be sorted according to the weights. The pairs argument is only used for the methods greedy.weighted and strictly.weighted and can be NULL (in which case a default is constructed in lexicographical order).

method

character string indicating the sorting method to be used. Available methods are:

"front.loaded":

Sort all pairs such that the first variables appear the most frequently early in the sequence; an Eulerian path; note that it might be slightly longer than the number of pairs because, first, an even graph has to be made.

"back.loaded":

Sort all pairs such that the later variables appear the most frequently later in the sequence; an Eulerian path (+ see front.loaded concerning length)

"balanced":

Sort all pairs such that all variables appear in balanced blocks throughout the sequence (a Hamiltonian Decomposition; Eulerian, too).

"eulerian.cross":

Generate a sequence of pairs such that each is formed with one variable from each group.

"greedy.weighted":

Sort all pairs according to a greedy (heuristic) Euler path with x as weights visiting each edge precisely once.

"strictly.weighted":

Strictly respect the order of the weights - so the first, second, third, and so on, adjacent pair of numbers of the output of zenpath() corresponds to the pair with largest, second-largest, third-largest, and so on, weight.

decreasing

A logical indicating whether the sorting is done according to increasing or decreasing weights.

Value

Returns a sequence of variables (indices or names, possibly a list of such), which can then be used to index the data (via groupData()for plotting via zenplot().

See Also

zenplot() which provides the zenplot.

Other tools related to constructing zenpaths: connect_pairs, extract_pairs, graph_pairs, groupData, indexData

Examples

# NOT RUN {
## Some calls of zenpath()
zenpath(10) # integer argument
## Note that the result is of length 50 > 10 choose 2 as the underlying graph has to
## be even (and thus edges are added here)
(zp <- zenpath(c(3, 5), method = "eulerian.cross")) # integer(2) argument

# }