screen.KMeans: pca.KMeans

In SMLMS/pguXAI:

Description

Performs KMeans clustering on a given pca dataset.

Format

[R6::R6Class] object.

Details

Performs KMeans clustering on a given pca dataset.

Active bindings

seed

Returns the instance variable seed (integer)

setSeed

Sets the instance variable seed (integer)

maxCluster

Returns the instance variable maxCluster (integer)

setMaxCluster

Sets the instance variable maxCluster (integer)

df_data

Returns the instance variable df_data (tbl_df)

df_wcss

Returns the instance variable df_wcss (tbl_df)

df_silhouette

Returns the instance variable df_silhouette (tbl_df)

verbose

Returns the instance variable verbose (logical)

Methods

Public methods

• screen.KMeans$new()

• screen.KMeans$finalize()

• screen.KMeans$print()

• screen.KMeans$train()

• screen.KMeans$kmeansAnalysis()

• screen.KMeans$wcssAnalysis()

• screen.KMeans$silhouetteAnalysis()

• screen.KMeans$clone()

---

Method new()

Creates and returns a new screen.KMeans object.

Usage

screen.KMeans$new(n = 2, seed = 42, verbose = FALSE)

Arguments

n

Initial number of maxCluster (integer)

seed

An initial seed. Default is 42 (integer)

verbose

Makes the class chatty. Default is FALSE. (logical)

Returns

A new R6 object of type pca.KMeans. (pguXAI::pca.KMeans)

---

Method finalize()

Clears the heap and indicates that instance of pca.KMeans is removed from heap.

Usage

screen.KMeans$finalize()

---

Method print()

Prints instance variables of screen.KMeans object.

Usage

screen.KMeans$print()

Returns

string

---

Method train()

trains the model

Usage

screen.KMeans$train(obj = "tbl_df", n = 10)

Arguments

obj

The data to be analyzed. Needs to be the result of a pca analysis. (tibble::tibble)

n

number of iterations (integer)

---

Method kmeansAnalysis()

Performs an iterative KMeans step. Not to run by the user.

Usage

screen.KMeans$kmeansAnalysis(obj, n)

Arguments

obj

The data to be analyzed. Needs to be the result of a pca analysis. (tibble::tibble)

n

Seed additive (integer)

Returns

Result dataframe of the kmeans analysis. (tbl_df)

---

Method wcssAnalysis()

Performs wcss analysis on df_data. Not to run by the user.

Usage

screen.KMeans$wcssAnalysis()

---

Method silhouetteAnalysis()

Performs silhouette analysis on df_data. Not to run by the user.

Usage

screen.KMeans$silhouetteAnalysis()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

screen.KMeans$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Author(s)

Sebastian Malkusch, [e-mail]

SMLMS/pguXAI documentation built on Aug. 15, 2020, 7:09 a.m.