checkem: First Gate Function

Description Usage Arguments Value

View source: R/monoclust.R

Description

This function checks what are available nodes to split and then call find_split() on each node, then decide which node creates best split, and call splitter() to perform the split.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
checkem(
  data,
  cuts,
  frame,
  cloc,
  dist,
  variables,
  minsplit,
  minbucket,
  split_order,
  ncores
)

Arguments

data

Original data set.

cuts

Cuts data set, which has the next higher value of each variable in the original data set.

frame

The split tree transferred as data frame.

cloc

Vector of current cluster membership.

dist

Distance matrix of all observations in the data. exported function yet. Vector of 1 for all observations.

variables

List of variables selected for clustering procedure. It could be a vector of variable indexes, or a vector of variable names.

minsplit

The minimum number of observations that must exist in a node in order for a split to be attempted.

minbucket

The minimum number of observations in any terminal leaf node. Default is minsplit/3.

split_order

The control argument to see how many split has been done.

ncores

Number of CPU cores on the current host.

Value

It is not supposed to return anything because global environment was used. However, if there is nothing left to split, it returns 0 to tell the caller to stop running the loop.


monoClust documentation built on Feb. 15, 2021, 5:07 p.m.