README.md

SWKM

The goal of SWKM is to perform (sparse) weighted K-Means algorithm on observations with weights. If some observations are known to be noisier than the others, the method in this package can be applied to adaptively tune weights and cluster the data.

Installation

You can install the released version of SWKM from Github:

library(devtools)
devtools::install_github("Van1yu3/SWKM")

As this package depends on the RcppArmadillo package, Windows users should install Rtools in advance to compile the package.

Main Functions

kmeans.weight: Perform weighted K-Means algorithm on data.

kmeans.weight.tune: Choose weight parameter for (sparse) weighted K-Means algorithm. Usually used before kmeans.weight or KMeansSparseCluster.weight.

KMeansSparseCluster.weight: Perform sparse weighted K-Means algorithm on data.

KMeansSparseCluster.permute.weight: Choose sparsity parameter for sparse weighted K-Means algorithm. Usually used before KMeansSparseCluster.weight, and after weight parameter is tuned or known.

ChooseK: Choose the number of clusters K for (sparse) weighted K-Means clustering. Usually used before clustering method is performed.

Examples

Please refer to the vigenette with two examples for a quick guide to SWKM package.



Van1yu3/SWKM documentation built on Sept. 3, 2019, 7:50 a.m.