remoraConfiguration {frbf}R Documentation

Remora configuration constructor

Description

Builds a remora configuration object.

Usage

remoraConfiguration(number_clusters, class_name, weighting_function = FUNCTION_REMORA_EUCLIDEAN, scale_variance = TRUE, s_value = 0.2, d = 0.23, epsilon = 0.01, niter = -1, niter_changes = 5, perform_sum = TRUE, clustering_algorithm = "", verbose = VERBOSE_NO)

Arguments

number_clusters the total number of clusters, may be adjusted during the execution and will be used by the K-Means algorithm
class_name the name, or index, of the column that holds the class of the training data matrix
weighting_function the name of the kernel function from the options "euclidean", "one_minus", "one_minus_sq", "mahalanobis", "exp_one_minus", "exp_one_minus_sq", "exp_one_log", "normalized_difference", "normalized_difference_sq", if none is specified, the "euclidean" function will be used
scale_variance specifies if the scale should be performed for the principal components analysis, default is True (see prcomp)
s_value the initial value to use to find the s value, to use to find the kernels sigma value, the spread parameter adjustment, it has a default value of 0.2
d the initial d value to use to find the s value, it will use the default value of 0.23 if no value is specified
epsilon the epsilon for the functions that require it, if none is specified a default value of 0.01 will be used
niter the maximum number of iterations to perform to find s, if no value is provided, a default will be calculated based on the number of training data points
niter_changes the number of iteraction without changes that can occur, if this number is reached withou any change, the iteration will stop, if no value is specified 5 will be used by default
perform_sum specifies if the sum of the centroids per cluster should be applied, or not, default is True
clustering_algorithm specifies which of the K-Means algorithms should be used, if none is specified, the default K-Means algorithm will be used
verbose specifies the algorithm verbosity during the execution, from "no", "yes", "detail", "debug" options, if nothing is specified it will be "no"

Details

Missing values for parameters that do not have a default value will halt the frbf execution.

Value

Returns the configuration in RemoraConfiguration object.

Note

This function is part of the frbf implementation and is for internal use only.

Author(s)

Fernando Martins

See Also

RemoraConfiguration


[Package frbf version 1.0.1 Index]