setVarySettings {segmenTier}R Documentation

Parameters for segmentCluster.batch.

Description

Generates the parameter list (varySettings) for segmentCluster.batch, using defaults for all parameters not passed.

Usage

setVarySettings(E = c(1, 3), S = "ccor", M = 100, Mn = 100,
  a = -2, nui = c(1, 3), nextmax = TRUE, multi = "max",
  multib = "max")

Arguments

E

exponent to scale similarity matrices

S

the scoring function to be used: "ccor", "icor" or "ccls"

M

segment length penalty. Note, that this is not a strict cut-off but defined as a penalty that must be "overcome" by good score.

Mn

segment length penalty for nuisance cluster. Mn<M will allow shorter distances between "real" segments; only used in scoring functions "ccor" and "icor"

a

a cluster "dissimilarity" only used for pure cluster-based scoring w/o cluster similarity measures in scoring function "ccls".

nui

the similarity score to be used for nuisance clusters in the cluster similarity matrices

nextmax

go backwards while score is increasing before opening a new segment, default is TRUE

multi

handling of multiple k with max. score in forward phase, either "min" (default) or "max"

multib

handling of multiple k with max. score in back-trace phase, either "min" (default), "max" or "skip"

Value

Returns a parameter settings structure that can be used in the batch function segmentCluster.batch.


[Package segmenTier version 0.1.2 Index]