check_specs: Check specifications of PLS-PM algorithm

View source: R/check_specifications.r

check_specsR Documentation

Check specifications of PLS-PM algorithm

Description

Internal function not to be called by the user

Usage

  check_specs(blocks, scaling, modes, scheme, scaled, tol,
    maxiter, plscomp)

Arguments

blocks

list defining the blocks of manifest variables

scaling

list with type of scaling for each manifest variable

modes

character vector specifying the modes

scheme

character string indicating the inner weighting scheme

scaled

should manifest variables be standardized

tol

character indicating the inner weighting scheme

maxiter

character indicating the inner weighting scheme

plscomp

optional vector indicating the number of PLS components (for each block) to be used when handling non-metric data (only used if scaling is provided)

Details

Internal function. check_specs is called by check_args.

Value

validated specifications

Warning

Do NOT use this function unless you are ME, a package developer, or a jedi user who really knows what is doing (seriously!)

Note

if scaling is specified, it overrides scaled


gastonstat/plspm documentation built on April 8, 2022, 5:59 a.m.