Clusterization-class {kml}R Documentation

~ Class: Clusterization ~

Description

An object of class Clusterization is a partition of trajectories in subgroups. The object also contains some information like the percentage of trajectories that each group contains or the Calinski criterion.

Objects from the Class

Objects are not intend to be created by users. Clusterization are created by kml and directly added to a "ClusterizLongData" object.

Slots

id
[vector(character)]: single identifier for each individual.
nbClusters
[numeric]: number of groups, between 2 and 25
clusters
[vector(factor)]: vector containing the affectation groups of each individual. The groups are in capital letters, from A to LETTERS[nbClusters]. Please note that a group might be empty. The groups are sort by size: (A is the biggest group, B is the next,...)
percentEachCluster
[vector(numeric)]: percentage of trajectories contained in each group.
calinski
[numeric]: Calinski criterion (formula : trace(B)/trace(W)*(g-1)/(n-g) with B=matrice of variance Between, W=matrice of variance Within, g=number of groups and n=number of individual.)
convergenceTime:
[numeric] number of iteration necessary to kml to find the Clusterization

validation rules

A class Clusterization object must follow some rules to be valid:

Construction

Class Clusterization objects are constructed through the kml procedure and are directy add to a ClusterizLongData object. They are not intend to be construct by the users.

Getteur [

Object["id"]
[vecteur(character)]: Gets each individual indentifiant (the value of the slot id)
Object["nbClusters"]
[numeric]: Gets the number of clusters (the value of the slot nbClusters)
Object["clusters"]
[vector(factor)]: Gets the cluster of each individual (the value of the slot clusters)
Object["percentEachClusters"]
[numeric]: Gets the percent of individual present in each clusters.
Object["calinski"]
[numeric]: Gets the calinski criterion of the Clusterization.
Object["convergenceTime"]
[numeric]: Gets the convergence time of the Clusterization.

Setteur [<-

Object["id"]<-value
[vecteur(character)]: Sets the individual indentifiant to value.
Object["nbClusters"]<-value
[numeric]: Sets the number of clusters to value.
Object["clusters"]<-value
[vector(factor)]: Sets the cluster of each individual.

"percentEachClusters", "calinski" and "convergenceTime" are calculate by the creation function according to the clusterization. They are not suppose to be change by te user.

Author(s)

Christophe Genolini
PSIGIAM: Paris Sud Innovation Group in Adolescent Mental Health
INSERM U669 / Maison de Solenn / Paris

Contact author : <genolini@u-paris10.fr>

English translation

Raphaël Ricaud
Laboratoire "Sport & Culture" / "Sports & Culture" Laboratory
University of Paris 10 / Nanterre

References

Article submited
Web site: http://christophe.genolini.free.fr/kml

See Also

Overview: kml-package
Classes : ClusterizLongData, Clusterization, ArtificialLongData
Methods : kml

Examples

showClass("Clusterization")

[Package kml version 0.9.2 Index]