Conload: Difference between revisions

From Eigenvector Research Documentation Wiki
Jump to navigation Jump to search
imported>Jeremy
(Importing text file)
imported>Jeremy
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
===Purpose===
===Purpose===
Congruence loadings for PARAFAC, TUCKER and NPLS.
Congruence loadings for PARAFAC, TUCKER and NPLS.
===Synopsis===
===Synopsis===
:Bcon = conload(X,model,''options'')
 
:bcon = conload(x,model,mode,''options'')
 
===Description===
===Description===
Determines congruence (earlier known as correlation) loadings for a specific mode of a model. Congruence loadings look at "non-average correlations", hence take differences in offset into account.
Determines congruence (earlier known as correlation) loadings for a specific mode of a model. Congruence loadings look at "non-average correlations", hence take differences in offset into account.
Note that due to non-orthogonal loadings in PARAFAC, individual correlations can add to more than 1. Therefore, such loadings are not drawn with ellipses but squares added. Use options.force = 'ellipse' or 'square' to force one or the other on the plot.
Note that due to non-orthogonal loadings in PARAFAC, individual correlations can add to more than 1. Therefore, such loadings are not drawn with ellipses but squares added. Use options.force = 'ellipse' or 'square' to force one or the other on the plot.
====INPUTS====
 
* '''X''' = modeled data
====Inputs====
* '''model''' = standard model structure
 
* '''mode''' = loading mode to investigate (i.e. mode = 1 for samples if they are in the first mode)
x = modeled data
====OUTPUTS====
 
Bcon = Congruence loadings
model = standard model structure
 
mode = loading mode to investigate (i.e., mode = 1 for samples if they are in the first mode / rows)
 
====Outputs====
 
bcon = congruence loadings
 
===Options===
===Options===
''options'' is an options structure with the following fields:
* '''plots''' : [ 'none' | {'final'} ] Governs the creation of plot of the results.
* '''plots''' : [ 'none' | {'final'} ] Governs the creation of plot of the results.
* '''force''' : [ {'off'} | 'ellipse' | 'square' ] Forces a given type of limit on the plots (if plot is given).
* '''force''' : [ {'off'} | 'ellipse' | 'square' ] Forces a given type of limit on the plots (if plot is given).
===See Also===
===See Also===
[[npls]], [[parafac]], [[tucker]]
[[npls]], [[parafac]], [[tucker]]

Latest revision as of 14:54, 9 June 2014

Purpose

Congruence loadings for PARAFAC, TUCKER and NPLS.

Synopsis

bcon = conload(x,model,mode,options)

Description

Determines congruence (earlier known as correlation) loadings for a specific mode of a model. Congruence loadings look at "non-average correlations", hence take differences in offset into account.

Note that due to non-orthogonal loadings in PARAFAC, individual correlations can add to more than 1. Therefore, such loadings are not drawn with ellipses but squares added. Use options.force = 'ellipse' or 'square' to force one or the other on the plot.

Inputs

x = modeled data

model = standard model structure

mode = loading mode to investigate (i.e., mode = 1 for samples if they are in the first mode / rows)

Outputs

bcon = congruence loadings

Options

options is an options structure with the following fields:

  • plots : [ 'none' | {'final'} ] Governs the creation of plot of the results.
  • force : [ {'off'} | 'ellipse' | 'square' ] Forces a given type of limit on the plots (if plot is given).

See Also

npls, parafac, tucker