foreman | R Documentation |
The central hub of the cSEM package. It acts like a
foreman by collecting all (estimation) tasks, distributing them to lower
level package functions, and eventually recollecting all of their results.
It is called by csem()
to manage the actual calculations.
It may be called directly by the user, however, in most cases it will likely
be more convenient to use csem()
instead.
foreman( .data = args_default()$.data, .model = args_default()$.model, .approach_cor_robust = args_default()$.approach_cor_robust, .approach_nl = args_default()$.approach_nl, .approach_paths = args_default()$.approach_paths, .approach_weights = args_default()$.approach_weights, .conv_criterion = args_default()$.conv_criterion, .disattenuate = args_default()$.disattenuate, .dominant_indicators = args_default()$.dominant_indicators, .estimate_structural = args_default()$.estimate_structural, .id = args_default()$.id, .instruments = args_default()$.instruments, .iter_max = args_default()$.iter_max, .normality = args_default()$.normality, .PLS_approach_cf = args_default()$.PLS_approach_cf, .PLS_ignore_structural_model = args_default()$.PLS_ignore_structural_model, .PLS_modes = args_default()$.PLS_modes, .PLS_weight_scheme_inner = args_default()$.PLS_weight_scheme_inner, .reliabilities = args_default()$.reliabilities, .starting_values = args_default()$.starting_values, .tolerance = args_default()$.tolerance )
.data |
A |
.model |
A model in lavaan model syntax or a cSEMModel list. |
.approach_cor_robust |
Character string. Approach used to obtain a robust
indicator correlation matrix. One of: "none" in which case the standard
Bravais-Pearson correlation is used,
"spearman" for the Spearman rank correlation, or
"mcd" via |
.approach_nl |
Character string. Approach used to estimate nonlinear structural relationships. One of: "sequential" or "replace". Defaults to "sequential". |
.approach_paths |
Character string. Approach used to estimate the
structural coefficients. One of: "OLS" or "2SLS". If "2SLS", instruments
need to be supplied to |
.approach_weights |
Character string. Approach used to obtain composite weights. One of: "PLS-PM", "SUMCORR", "MAXVAR", "SSQCORR", "MINVAR", "GENVAR", "GSCA", "PCA", "unit", "bartlett", or "regression". Defaults to "PLS-PM". |
.conv_criterion |
Character string. The criterion to use for the convergence check. One of: "diff_absolute", "diff_squared", or "diff_relative". Defaults to "diff_absolute". |
.disattenuate |
Logical. Should composite/proxy correlations
be disattenuated to yield consistent loadings and path estimates if at least
one of the construct is modeled as a common factor? Defaults to |
.dominant_indicators |
A character vector of |
.estimate_structural |
Logical. Should the structural coefficients
be estimated? Defaults to |
.id |
Character string or integer. A character string giving the name or
an integer of the position of the column of |
.instruments |
A named list of vectors of instruments. The names
of the list elements are the names of the dependent (LHS) constructs of the structural
equation whose explanatory variables are endogenous. The vectors
contain the names of the instruments corresponding to each equation. Note
that exogenous variables of a given equation must be supplied as
instruments for themselves. Defaults to |
.iter_max |
Integer. The maximum number of iterations allowed.
If |
.normality |
Logical. Should joint normality of
[η_(1:p); ζ; ε]
be assumed in the nonlinear model? See \insertCiteDijkstra2014cSEM for details.
Defaults to |
.PLS_approach_cf |
Character string. Approach used to obtain the correction
factors for PLSc. One of: "dist_squared_euclid", "dist_euclid_weighted",
"fisher_transformed", "mean_arithmetic", "mean_geometric", "mean_harmonic",
"geo_of_harmonic". Defaults to "dist_squared_euclid".
Ignored if |
.PLS_ignore_structural_model |
Logical. Should the structural model be ignored
when calculating the inner weights of the PLS-PM algorithm? Defaults to |
.PLS_modes |
Either a named list specifying the mode that should be used for
each construct in the form |
.PLS_weight_scheme_inner |
Character string. The inner weighting scheme
used by PLS-PM. One of: "centroid", "factorial", or "path".
Defaults to "path". Ignored if |
.reliabilities |
A character vector of |
.starting_values |
A named list of vectors where the
list names are the construct names whose indicator weights the user
wishes to set. The vectors must be named vectors of |
.tolerance |
Double. The tolerance criterion for convergence.
Defaults to |
csem, cSEMResults
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.