dtwclust (version 3.1.1)

tsclust-controls: Control parameters for clusterings with tsclust

Description

Control parameters for tsclust.

Usage

partitional_control(pam.precompute = TRUE, iter.max = 100L, nrep = 1L, symmetric = FALSE, packages = character(0L), distmat = NULL)
hierarchical_control(method = "average", symmetric = FALSE, packages = character(0L), distmat = NULL)
fuzzy_control(fuzziness = 2, iter.max = 100L, delta = 0.001, packages = character(0L))
tadpole_control(dc, window.size, lb = "lbk")
tsclust_args(preproc = list(), dist = list(), cent = list())

Arguments

pam.precompute

Logical flag. Precompute the whole distance matrix once and reuse it on each iteration if using PAM centroids. Otherwise calculate distances at every iteration.

iter.max

Integer. Maximum number of allowed iterations for partitional/fuzzy clustering.

nrep

Integer. How many times to repeat clustering with different starting points.

symmetric

Logical flag. Is the distance function symmetric? In other words, is dist(x,y) == dist(y,x)? If TRUE, only half the distance matrix needs to be computed. Overridden if the function detects an invalid user-provided value.

packages

Character vector with the names of any packages required for custom proxy functions. Since the distance entries are re-registered in each parallel worker if needed, this slot is probably useless, but just in case.

distmat

If available, the cross-distance matrix can be provided here. Only relevant for partitional with PAM centroids or hierarchical procedures.

method

Character vector with one or more linkage methods to use in hierarchical procedures (see hclust), the character "all" to use all of the available ones, or a function that performs hierarchical clustering based on distance matrices (e.g. diana).

fuzziness

Numeric. Exponent used for fuzzy clustering. Commonly termed m in the literature.

delta

Numeric. Convergence criterion for fuzzy clustering.

dc

The cutoff distance for the TADPole algorithm.

window.size

The window.size specifically for the TADPole algorithm.

lb

The lower bound to use with TADPole. Either "lbk" or "lbi".

preproc

A list of arguments for a preprocessing function to be used in tsclust.

dist

A list of arguments for a distance function to be used in tsclust.

cent

A list of arguments for a centroid function to be used in tsclust.

Details

The functions essentially return their function arguments in a classed list, although some checks are performed.

When using TADPole, the dist argument list includes the window.size and specifies norm = "L2".