hydraPlus {hydra} | R Documentation |
hydra
with additional stress minimization
Description
Runs the hydra
method and then performs a further optimization step by minimizing the stress of the embedding and optimizing hyperbolic curvature
Usage
hydraPlus(D, dim = 2, curvature = 1, alpha = 1.1, equi.adj = 0.5,
control = list(), curvature.bias = 1, curvature.freeze = TRUE,
curvature.max = NULL, maxit = 1000, ...)
Arguments
D |
a square symmetric matrix of distances (or dissimiliarities) to be embdedded, can also be a |
dim |
embedding dimension |
curvature |
embedding curvature; if this argument is NULL, hydra tries to find the optimal curvature |
alpha |
real number greater one; adjusts the hyperbolic curvature. Values larger than one yield a more distorted embedding where points are pushed
to the outer boundary (i.e. the ideal points) of hyperblic space. The interaction between |
equi.adj |
equi-angular adjustment; must be a real number between zero and one; only used if |
control |
a list which may contain the following boolean flags:
|
curvature.bias |
Modify curvature before stress minimization by multiplying with |
curvature.freeze |
Freeze the curvature returned by |
curvature.max |
Upper bound for the curvature. If NULL, a defulat bound is used |
maxit |
Maximal number of iterations. This parameter is passed to the optimization routine |
... |
Additional parameters are passed to |
Details
See https://arxiv.org/abs/1903.08977 for more details.
Value
A ‘hydra’ object, which is a list with all or some of the following components:
- r
a vector containing the radial coordinates of the embedded points
- directional
a matrix with
dim
columns containing as rows the directional coordinates of the embedded points- theta
a vector containing the angular coordinates of the embedded points (only returned if
dim
is 2 andpolar
flag is TRUE)- curvature
the curvature used for the returned embedding
- dim
the dimension used for the returned embedding
- stress
the stress (i.e. the mean-square difference) between distances supplied in
D
and the hyperbolic distance matrix of the returned embedding- dist
the hyperbolic distance matrix of the returned embedding (only returned if flag
return.dist
is true. Computation may be time- and memory-intensive.)- x0
a vector containing the 'time-like' coordinate of the raw Lorentz embedding (only returned if flag
return.lorentz
is true)- X
a matrix with
dim
columns containing as rows the 'space-like' coordinate of the raw Lorentz embedding (only returned if flagreturn.lorentz
is true)
Author(s)
Martin Keller-Ressel <martin.keller-ressel@tu-dresden.de>
Examples
data(karate)
embedding <- hydraPlus(karate$distance)
plot(embedding,labels=karate$label,node.col=karate$group,graph.adj=karate$adjacency)