check_args: Check arguments for 'plspm' and 'plspm.fit'

View source: R/check_arguments.R

check_argsR Documentation

Check arguments for plspm and plspm.fit

Description

Internal function not to be called by the user

Usage

  check_args(Data, path_matrix, blocks, scaling, modes,
    scheme, scaled, tol, maxiter, plscomp, boot.val, br,
    dataset)

Arguments

Data

numeric matrix or data frame containing the manifest variables.

path_matrix

square (lower triangular) boolean matrix for inner model.

blocks

List of vectors (either numeric or character) to specify the blocks of manifest variables asociated to the latent variables.

scaling

optional list of string vectors indicating the type of measurement scale for each manifest variable specified in blocks.

modes

character indicating the type of measurement.

scheme

string indicating the type of inner weighting scheme.

scaled

logical indicating whether scaling data is performed.

tol

decimal value indicating the tol criterion for covergence.

maxiter

integer indicating the maximum number of iterations.

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)

boot.val

whether bootstrap validation is performed.

br

integer indicating the number bootstrap resamples.

dataset

whether the data matrix should be retrieved.

Details

Internal function. check_args is called by plspm.

Value

list of validated arguments

Warning

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


plspm documentation built on June 22, 2024, 11:29 a.m.