seriation (version 1.4.1)

get_order: Extracting Order Information from a Permutation Object

Description

Method to get the order information from an object of class ser_permutation or ser_permutation_vector. Order information can be extracted as an integer permutation vector, a vector containing the object ranks or a permutation matrix.

Usage

get_order(x, ...)
# S3 method for ser_permutation_vector
get_order(x, ...)
# S3 method for ser_permutation
get_order(x, dim = 1, ...)
# S3 method for hclust
get_order(x, ...)
# S3 method for dendrogram
get_order(x, ...)
# S3 method for integer
get_order(x, ...)
get_rank(x, ...)
get_permutation_matrix(x, ...)

Value

Returns an integer permutation vector/a permutation matrix.

Arguments

x

an object of class ser_permutation or ser_permutation_vector.

...

further arguments are ignored for get_order(). For get_rank() and for get_permutation_matrix() the additional arguments are passed on to get_order() (e.g., as dim).

dim

order information for which dimension should be returned?

Author

Michael Hahsler

Details

get_order() returns the seriation as an integer vector containing the order of the objects after permutation. That is, the index of the first, second, \(..., n\)-th object. These permutation vectors can directly be used to reorder objects using subsetting with "[". Note: In seriation we usually use these order-based permutation vectors.

get_rank() returns the seriation as an integer vector containing the rank/position for each objects in the permutation. That is, position of the first, second, \(..., n\)-th object after permutation. Note: Use order() to convert ranks back to an order.

get_permutation_matrix() returns a \(n \times n\) permutation matrix.

See Also

Other permutation: permutation_vector2matrix(), permute(), ser_dist(), ser_permutation_vector(), ser_permutation()

Examples

## ser_permutation_vector is a single permutation vector
o <- ser_permutation_vector(sample(10))
o

get_order(o)
get_rank(o)
get_permutation_matrix(o)

## ser_permutation contains one permutation vector for each dimension
o2 <- ser_permutation(o, sample(5))
o2

get_order(o2, dim = 2)
get_rank(o2, dim = 2)
get_permutation_matrix(o2, dim = 2)