get.dmetrics: List the names of distance metrics

Description Usage Arguments Value Author(s) References See Also Examples

View source: R/tools.R

Description

Displays the distance metric options for calculation of the distances between the data objects and the cluster centers.

Usage

1
get.dmetrics(dmt="all")

Arguments

dmt

a string for the type of distance metrics. The default is all for the list of all of the distance metrics which are available in the package. The other options are l1, l2, lp, sl2 and sc for L1, L2, Lp, squared L2 and squared Chord, respectively.

Value

dmlist

a two-column matrix containing the distance metrics and their descriptions.

Author(s)

Zeynel Cebeci

References

Podani, J. (2000). Introduction to the Exploration of Multivariate Biological Data. Backhuys Publishers, Leiden, The Netherlands. 407 pages. <ISBN 90-5782-067-6>

McCune, B., & Grace, J. B. (2002). Analysis of ecological communities. Gleneden Beach, Oregon: MjM Software Design. <ISBN:0972129006>

See Also

ppclust-package

Examples

1
2
3
4
5
6
7
# Get all distance metrics
dmlist <- get.dmetrics(dmt="all")
dmlist

# Get only L2 type distance metrics
dmlist <- get.dmetrics(dmt="l2")
dmlist

Example output

      dmetric       Description               Norm 
 [1,] "addsymchi"   "Additive Symmetric"      "sl2"
 [2,] "canberra"    "Canberra"                "l1" 
 [3,] "chebyshev"   "Chebyshev"               "li" 
 [4,] "clark"       "Clark"                   "sl2"
 [5,] "correlation" "Correlation"             "cor"
 [6,] "cosine"      "Cosine"                  "cos"
 [7,] "divergence"  "Divergence"              "sl2"
 [8,] "euclidean"   "Euclidean"               "l2" 
 [9,] "lorentzian"  "Lorentzian"              "l1" 
[10,] "manhattan"   "Manhattan"               "l1" 
[11,] "minkowski"   "Minkowski"               "lp" 
[12,] "neymanchi"   "Neyman Chi"              "sl2"
[13,] "pearsonchi"  "Pearson Chi"             "sl2"
[14,] "prosymchi"   "Probabilistic Symmetric" "sl2"
[15,] "sorensen"    "Sorensen"                "l1" 
[16,] "sqchi"       "Squared Chi"             "sl2"
[17,] "sqchord"     "Squared Chord"           "sc" 
[18,] "sqeuclidean" "Squared Euclidean"       "sl2"
    dmetric Description        Norm 
"euclidean" "Euclidean"        "l2" 

ppclust documentation built on Feb. 9, 2020, 5:07 p.m.