[d79ff0]: / man / getSilhouette.Rd

Download this file

35 lines (32 with data), 1.1 kB

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/getSilhouette.R
\name{getSilhouette}
\alias{getSilhouette}
\title{Get Silhouette Coefficient from (s)PCA, (s)PLS or block.(s)PLS clusters}
\usage{
getSilhouette(object)
}
\arguments{
\item{object}{a mixOmics object of the class \code{pca}, \code{spca}, \code{pls}, \code{spls}, \code{block.pls}, \code{block.spls}}
}
\value{
silhouette coefficient
}
\description{
\code{getSilhouette} is a generic function that compute silhouette coefficient
for an object of the type \code{pca}, \code{spca}, \code{pls}, \code{spls},
\code{block.pls}, \code{block.spls}.
}
\details{
This method extract the componant contribution depending on the object,
perform the clustering step, and compute the silhouette coefficient.
}
\examples{
demo <- suppressWarnings(get_demo_cluster())
getSilhouette(object = demo$pca)
getSilhouette(object = demo$spca)
getSilhouette(object = demo$pls)
getSilhouette(object = demo$spls)
getSilhouette(object = demo$block.pls)
getSilhouette(object = demo$block.spls)
}