checkParams: Check optional dimensionaloty reduction method parameters

Description Usage Arguments Details Value Examples

View source: R/DimReduction.R

Description

Checks if optional parameters passed to dimensionality reduction method are valid and returns a list of all default and optinally set parameters.

Usage

1
checkParams(params, method)

Arguments

params

list of parameters to check; list names must be identical to argument names of chosen dimensionality reduction method.

method

Dimensionality reduction method character to be applied; one of DiffusionMap, DRR, ICA, LLE, Isomap, LaplacianEigenmap, MDS, PCA, kPCA, nMDS, tSNE and UMAP.

Details

checkParams checks if specified parameters are valid parameters of the underlying dimensionality reduction methods. A list of the methods is provided below:

Value

named list with default and specified parameters taken by specified dimensionality reduction method

Examples

1
2
params_DRR <- checkParams(list(cv.folds=10), method="DRR")
params_ICA <- checkParams(list(fun="logcosh", maxit=500), method="ICA")

HannahVMeyer/DrStable documentation built on Jan. 29, 2021, 11:42 a.m.