pmml (version 1.5.1)

pmml.hclust: Generate PMML for hclust objects

Description

Generate the PMML representation for a hierarchical cluster object. The hclust object will be approximated by k centroids and is converted into a PMML representation for kmeans clusters.

Usage

"pmml"(model, model.name="HClust_Model", app.name="Rattle/PMML", description="Hierarchical cluster model", copyright=NULL, transforms=NULL, unknownValue=NULL, centers, ...)

Arguments

model

a hclust object.

model.name

a name to be given to the model in the PMML code.

app.name

the name of the application that generated the PMML code.

description

a descriptive text for the Header element of the PMML code.

copyright

the copyright notice for the model.

transforms

data transformations represented in PMML via pmmlTransformations.

unknownValue

value to be used as the 'missingValueReplacement' attribute for all MiningFields.

centers

a list of means to represent the clusters.

...

further arguments passed to or from other methods.

Details

This function converts a hclust object created by the 'hclusterpar' function from the 'amap' package. A hclust object is a cluster model created hierarchically. The data is divided recursively until a criteria is met. This function then takes the final model and represents it as a standard k-means cluster model. This is possible since while the method of constructing the model is different, the final model can be represented in the same way.

To use this pmml function, therefore, one must pick the number of clusters desired and the coordinate values at those cluster centers. This can be done using the 'hclusterpar' and 'centers.hclust' functions from the 'amap' and 'rattle' packages repectively.

References

R project: Hierarchical Clustering

Examples

## Not run: 
# # cluster the 4 numeric variables of the iris dataset
# library(amap)
# model <- hclusterpar(iris[,-5])
# 
# # Get the information about the cluster centers. The last 
# # parameter of the function used is the number of clusters
# # desired.
#  library(rattle)
#  centerInfo <- centers.hclust(iris[,-5],model,3)
# 
# # convert to pmml
# library(pmml)
# pmml(model,centers=centerInfo)
# ## End(Not run)