Hitachieemreadr and Vipnway: Difference between pages

From Eigenvector Research Documentation Wiki
(Difference between pages)
Jump to navigation Jump to search
imported>Scott
No edit summary
 
imported>Scott
No edit summary
 
Line 1: Line 1:
===Purpose===
===Purpose===


Reads Hitachi EEM files with Rayleigh removal.
Calculate Variable Importance in Projection from NPLS model.


===Synopsis===
===Synopsis===


:out = hitachieemreadr(filenames, options);
:vip_scores = vipnway(model)


===Description===
===Description===


Reads HITACHI EEM text files. Data points must be tab delimited.
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====
====Inputs====
* '''file''' = One of the following identifications of files to read:
 
:* A single string identifying the file to read
* '''model''' = A NPLS model structure from a NPLS model.
:: ('example')
:* A cell array of strings giving multiple files to read
:: ({'example_a' 'example_b' 'example_c'})
:* An empty array indicating that the user should be prompted to locate the file(s) to read
:: ([])


====Outputs====
====Outputs====
* '''out''' = A DataSet object with date, time, info (data from cell (1,1)), variable names (vars), sample names (samps), and data matrix (data).
===Options===
options =  a structure array with the following fields:


* '''waitbar''' : [ 'off' |{'on'}] Governs use of waitbars to show progress.
* '''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.
* '''scattercorrection''' : [ {'off'} | 'on'] calls [[flucut]] for Rayleigh correction.
* '''flucut''' : [[flucut|FLUCUT]] options field for governing calls to [[flucut|FLUCUT]].
** '''LowZero''' : Option (LowZero) for [[flucut|FLUCUT]].
** '''TopZero''' : Option (TopZero) for [[flucut|FLUCUT]].
* '''LowMiss''' : Input (LowMiss) to [[flucut|FLUCUT]].
* '''TopMiss''' : Input (FopMiss) to [[flucut|FLUCUT]].
* '''textreadr''' : TEXTREADR options field for governing calls to [[textreadr|TEXTREADR]].


===See Also===
===See Also===


[[Data Importing Formats]], [[aqualogreadr]], [[hjyreadr]], [[jascoeemreadr]], [[jcampreadr]],
[[selectvars]], [[genalg]], [[ipls]], [[plotloads]], [[pls]], [[plsda]], [[sratio]], [[rpls]], [[vip]]
[[spcreadr]], [[writespc]], [[xclreadr]]

Revision as of 17:06, 18 December 2018

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

Retrieved from "https://www.wiki.eigenvector.com/index.php?title=Hitachieemreadr&oldid=10233"