imported>Lyle |
imported>Scott |
| Line 1: |
Line 1: |
| ===Issue:=== | | ===Purpose=== |
|
| |
|
| How do I obtain or use a recompilation license for PLS_Toolbox?
| | Calculate Variable Importance in Projection from NPLS model. |
|
| |
|
| ===Possible Solutions:=== | | ===Synopsis=== |
|
| |
|
| The standard [http://www.eigenvector.com/software/license_evri.html PLS_Toolbox license] does not permit recompilation of any part of the code without written permission from Eigenvector Research, Inc. This permission is usually in the form of a recompiliation license (for more information on recompilation licenses, see: our [http://www.eigenvector.com/evriblog/?p=27 Blog post on Compiling PLS_Toolbox] ).
| | :vip_scores = vipnway(model) |
|
| |
|
| If you have purchased a recompiliation license for PLS_Toolbox and/or other Matlab-based Eigenvector Research products, you can use the following instructions to compile your application including the licensed Eigenvector Research (EVRI) code.
| | ===Description=== |
|
| |
|
| # If you were not supplied an ''evrilicense.lic'' file by EVRI, create one by copying the license code supplied for your compilation license (found on the download tab of your EVRI account) into a plain-text file named: ''evrilicense.lic'' The file should consist of the license code on a single line of the file. For example: <pre>12345678-98765432-ab-1234-1234</pre>
| | Variable Importance in Projection (VIP) scores estimate the importance of each variable in the projection used in a NPLS model and is often used for variable selection. A variable with a VIP Score close to or greater than 1 (one) can be considered important in given model. Variables with VIP scores significantly less than 1 (one) are less important and might be good candidates for exclusion from the model. It works for X n-way and Y up to two-way and it assume samples are in the first mode. |
| # Copy the ''evrilicense.lic'' file into one of the folders on your Matlab path. This could be either one of the PLS_Toolbox folders, or your application's folder.
| |
| # Add the ''evrilicense.lic'' file to the "Shared Resources" list in the Matlab project builder. This will assure that the EVRI license gets included in the compiled application.
| |
| # Compile your application as usual using Mathworks' standard instructions. The Matlab dependency logic will automatically include the PLS_Toolbox functions in your compiled application. (See note below regarding "blocking" certain functions from being included.)
| |
|
| |
|
| '''Blocking Unnecessary Functions'''
| | ====Inputs==== |
|
| |
|
| By default, Matlab's compiler automatically identifies all m-files which are necessary to run your application and includes all of these in the compiler output. Because of the integrated nature of many of the PLS_Toolbox functions, this can lead to "sprawl" - inclusion of many more functions than are actually needed.
| | * '''model''' = A NPLS model structure from a NPLS model. |
|
| |
|
| One way to help reduce these unnecessary additions is to create empty "shell" functions to overload certain PLS_Toolbox functions. These functions, if placed in a folder above PLS_Toolbox when you are compiling, will shadow (hide) the actual function and help avoid sprawl. In particular the following functions are useful to shadow:
| | ====Outputs==== |
|
| |
|
| *analysis.m | | * '''vip_scores''' = a cell array with dimensions of: [modes 2 to n X # of columns in Y]. The first row in the cell array corresponds to VIP Scores for mode 2. The second row corresponds to VIP Scores for mode 3. |
| *browse.m
| |
| *plotgui.m
| |
| *browse.m
| |
| *evriinstall.m
| |
| *evrireporterror.m
| |
|
| |
|
| These functions will not be called in normal operation and, in most cases, our compilation licenses do not permit their inclusion in your application anyway.
| | ===See Also=== |
|
| |
|
| '''Uninstall the Stats Toolbox '''
| | [[selectvars]], [[genalg]], [[ipls]], [[plotloads]], [[pls]], [[plsda]], [[sratio]], [[rpls]], [[vip]] |
| | |
| Although moving the Stats Toolbox below PLS_Toolbox on your MATLAB path (or removing the Stats Toolbox folders altogether) will allow the PLS_Toolbox DataSet Object to function normally, you must uninstall the Stats Toolbox before compiling PLS_Toolbox function that require the DataSet Object.
| |
| | |
| The MathWorks states:
| |
| | |
| "When you compile [a program] into an application and run it, the MATLAB Compiler Run-time references its in-built Dataset function which is higher in its PATH and hence runs the data against this inbuilt Dataset function."
| |
| | |
| For more information on the DataSet Object history see here:
| |
| *[http://www.eigenvector.com/evriblog/?p=10 DataSet Object Conflict]
| |
| *[http://www.eigenvector.com/evriblog/?p=11 DataSet Object — Letter to MathWorks March 15, 2007]
| |
| | |
| [[Category:FAQ]] | |
Purpose
Calculate Variable Importance in Projection from NPLS model.
Synopsis
- vip_scores = vipnway(model)
Description
Variable Importance in Projection (VIP) scores estimate the importance of each variable in the projection used in a NPLS model and is often used for variable selection. A variable with a VIP Score close to or greater than 1 (one) can be considered important in given model. Variables with VIP scores significantly less than 1 (one) are less important and might be good candidates for exclusion from the model. It works for X n-way and Y up to two-way and it assume samples are in the first mode.
Inputs
- model = A NPLS model structure from a NPLS model.
Outputs
- vip_scores = a cell array with dimensions of: [modes 2 to n X # of columns in Y]. The first row in the cell array corresponds to VIP Scores for mode 2. The second row corresponds to VIP Scores for mode 3.
See Also
selectvars, genalg, ipls, plotloads, pls, plsda, sratio, rpls, vip