check.stopping: (Internal function) Check whether the IPCAPS2 process meets...

In kridsadakorn/ipcaps2: Iterative Pruning to Capture Population Structure version 2

(Internal function) Check whether the IPCAPS2 process meets the stopping criterion.

Description

(Internal function) Check whether the IPCAPS2 process meets the stopping criterion.

Usage

check.stopping(eigen.value, threshold)

Arguments

eigen.value	A vector of Eigenvalues return from svd ($d), rARPACK::svds ($d), eigen ($values) or rARPACK::eigs ($values).
threshold	A threshold or a cutoff to stop the IPCAPS2 process. Also see ipcaps2 (the parameter threshold).

Value

A list containing status, eigen.value, eigen.fit, threshold, and no.significant.PC as explained below:

• $status is either 0 representing that the criterion is not met, or 1 representing that the criterion is met.

• $eigen.value is a vector of Eigenvalues as the input parameter.

• $eigen.fit is a vector of EigenFit values.

• $threshold is a threashold as the input parameter.

• $no.significant.PC is an estimated number of sinificant principal components (PC).

kridsadakorn/ipcaps2 documentation built on June 11, 2022, 8:35 p.m.