Conload: Difference between revisions
Jump to navigation
Jump to search
imported>Jeremy (Importing text file) |
imported>Jeremy (Importing text file) |
||
| 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,''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==== | ====INPUTS==== | ||
* '''X''' = modeled data | * '''X''' = modeled data | ||
* '''model''' = standard model structure | * '''model''' = standard model structure | ||
* '''mode''' = loading mode to investigate (i.e. mode = 1 for samples if they are in the first mode) | * '''mode''' = loading mode to investigate (i.e. mode = 1 for samples if they are in the first mode) | ||
====OUTPUTS==== | ====OUTPUTS==== | ||
Bcon = Congruence loadings | Bcon = Congruence loadings | ||
===Options=== | ===Options=== | ||
* '''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]] | ||
Revision as of 14:24, 3 September 2008
Purpose
Congruence loadings for PARAFAC, TUCKER and NPLS.
Synopsis
- Bcon = conload(X,model,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)
OUTPUTS
Bcon = Congruence loadings
Options
- 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).