spmdda {smacofx} | R Documentation |
Sparse (POST-)Multidimensional Distance Analysis (SPMDDA or SMDDA) either as self-organizing or not
Description
An implementation of a sparsified version of (POST-)MDS by pseudo-majorization with ratio, interval and ordinal optimal scaling for geodesic distances and optional power transformations. This is inspired by curvilinear distance analysis but works differently: It finds an initial weightmatrix where w_ij(X^0)=0 if d_ij(X^0)>tau and fits a POST-MDS with these weights. Then in each successive iteration step, the weightmat is recalculated so that w_ij(X^(n+1))=0 if d_ij(X^(n+1))>tau. Right now the zero weights are not found by the correct optimization, but we're working on that.
Usage
spmdda(
delta,
lambda = 1,
kappa = 1,
nu = 1,
tau,
type = "ratio",
ties = "primary",
epsilon,
k,
path = "shortest",
fragmentedOK = FALSE,
weightmat = 1 - diag(nrow(delta)),
init = NULL,
ndim = 2,
acc = 1e-06,
itmax = 10000,
verbose = FALSE,
principal = FALSE
)
smdda(
delta,
tau = stats::quantile(delta, 0.9),
type = c("ratio"),
ties = "primary",
epsilon,
k,
path = "shortest",
fragmentedOK = FALSE,
weightmat = 1 - diag(nrow(delta)),
init = NULL,
ndim = 2,
acc = 1e-06,
itmax = 10000,
verbose = FALSE,
principal = FALSE
)
so_spmdda(
delta,
kappa = 1,
lambda = 1,
nu = 1,
tau = max(delta),
epochs = 10,
type = c("ratio"),
ties = "primary",
epsilon,
k,
path = "shortest",
fragmentedOK = FALSE,
weightmat = 1 - diag(nrow(delta)),
init = NULL,
ndim = 2,
acc = 1e-06,
itmax = 10000,
verbose = FALSE,
principal = FALSE
)
so_smdda(
delta,
tau = max(delta),
epochs = 10,
type = c("ratio"),
ties = "primary",
epsilon,
k,
path = "shortest",
fragmentedOK = FALSE,
weightmat = 1 - diag(nrow(delta)),
init = NULL,
ndim = 2,
acc = 1e-06,
itmax = 10000,
verbose = FALSE,
principal = FALSE
)
Arguments
delta |
dist object or a symmetric, numeric data.frame or matrix of distances |
lambda |
exponent of the power transformation of the dissimilarities; defaults to 1, which is also the setup of 'smdda' |
kappa |
exponent of the power transformation of the fitted distances; defaults to 1, which is also the setup of 'smdda'. |
nu |
exponent of the power of the weighting matrix; defaults to 1 which is also the setup for 'clca'. |
tau |
the boundary/neighbourhood parameter(s) (called lambda in the original paper). For 'spmdda' and 'smdda' it is supposed to be a numeric scalar (if a sequence is supplied the maximum is taken as tau) and all the transformed fitted distances exceeding tau are set to 0 via the weightmat (assignment can change between iterations). It defaults to the 90% quantile of the enormed (power transformed) geodesic distances of delta. For 'so_pclca' tau is supposed to be either a user supplied decreasing sequence of taus or if a scalar the maximum tau from which a decreasing sequence of taus is generated automatically as 'seq(from=tau,to=tau/epochs,length.out=epochs)' and then used in sequence. |
type |
what type of MDS to fit. Currently one of "ratio", "interval" or "ordinal". Default is "ratio". |
ties |
the handling of ties for ordinal (nonmetric) MDS. Possible are "primary" (default), "secondary" or "tertiary". |
epsilon |
Shortest dissimilarity retained. |
k |
Number of shortest dissimilarities retained for a point. If both 'epsilon' and 'k' are given, 'epsilon' will be used. |
path |
Method used in 'stepacross' to estimate the shortest path, with alternatives '"shortest"' and '"extended"'. |
fragmentedOK |
What to do if dissimilarity matrix is fragmented. If 'TRUE', analyse the largest connected group, otherwise stop with error. |
weightmat |
a matrix of finite weights. |
init |
starting configuration |
ndim |
dimension of the configuration; defaults to 2 |
acc |
numeric accuracy of the iteration. Default is 1e-6. |
itmax |
maximum number of iterations. Default is 10000. |
verbose |
should iteration output be printed; if > 1 then yes |
principal |
If 'TRUE', principal axis transformation is applied to the final configuration |
epochs |
for 'so_pclca' and tau being scalar, it gives the number of passes through the data. The sequence of taus created is 'seq(tau,tau/epochs,length.out=epochs)'. If tau is of length >1, this argument is ignored. |
Details
In 'spmdda' the logic is that we first transform to geodesic distance, then apply the explicit power transformation and then the implicit optimal scaling. There is a wrapper 'smdda' where the exponents are 1, which is standard SMDDA but extend to allow optimal scaling. The neighborhood parameter tau is kept fixed in 'spmdda' and 'smdda'. The functions 'so_spmdda' and 'so_smdda' implement a self-organising principle where the is repeatedly fitted for a decreasing sequence of taus.
The solution is found by "quasi-majorization", which mean that the majorization is only working properly after a burn-in of a few iterations when the assignment which distances are ignored no longer changes. Due to that it can be that in the beginning the stress may not decrease monotonically and that there's a chance it might never.
The geodesic distances are calculated via 'vegan::isomapdist', see isomapdist
for a documentation of what these distances do. The functions of '(p)smdda' are just a wrapper for '(p)clca' applied to the geodesic distances obtained via isomapdist.
If tau is too small it may happen that all distances for one i to all j are zero and then there will be an error, so make sure to set a larger tau.
In the standard functions 'spmdda' and 'smdda' we keep tau fixed throughout. This means that if tau is large enough, then the result is the same as the corresponding MDS. In the orginal publication the idea was that of a self-organizing map which decreased tau over epochs (i.e., passes through the data). This can be achieved with our function 'so_spmdda' 'so_smdda' which creates a vector of decreasing tau values, calls the function 'spmdda' with the first tau, then supplies the optimal configuration obtained as the init for the next call with the next tau and so on.
Value
a 'smacofP' object (inheriting from 'smacofB', see smacofSym
). It is a list with the components
delta: Observed, untransformed dissimilarities
tdelta: Observed explicitly transformed dissimilarities, normalized
dhat: Explicitly transformed dissimilarities (dhats), optimally scaled and normalized
confdist: Configuration dissimilarities
conf: Matrix of fitted configuration
stress: Default stress (stress 1; sqrt of explicitly normalized stress)
spp: Stress per point
ndim: Number of dimensions
model: Name of smacof model
niter: Number of iterations
nobj: Number of objects
type: Type of MDS model
weightmat: weighting matrix as supplied
stress.m: Default stress (stress-1^2)
tweightmat: transformed weighting matrix; it is weightmat but containing all the 0s for the distances set to 0.
Examples
dis<-smacof::morse
res<-spmdda(dis,kappa=2,lambda=2,tau=0.4,k=5,itmax=500) #use higher itmax
res
#already many parameters
coef(res)
res2<-smdda(dis,type="interval",tau=0.4,epsilon=1,itmax=500) #use higher itmax
res2
summary(res)
oldpar<-par(mfrow=c(1,2))
plot(res)
plot(res2)
par(oldpar)
##which d_{ij}(X) exceeded tau at convergence (i.e., have been set to 0)?
res$tweighmat
res2$tweightmat
## Self-organizing map style (as in the original publication)
#run the som-style (p)smdda
sommod1<-so_spmdda(dis,tau=2,k=5,kappa=0.5,lambda=2,epochs=10,verbose=1)
sommod2<-so_smdda(dis,tau=2.5,epsilon=1,epochs=10,verbose=1)
sommod1
sommod2