Analysis Window: Model Cache Pane and Importtool: Difference between pages

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


[[TableOfContents|Table of Contents]] | [[AnalysisWindow_AnalysisFlowChartPane|Previous]] | [[ModelBuilding_PreProcessingMethods|Next]]
GUI for designating column/row data types in incoming data.  Allows user to specify a column or row as labels, class sets, or axisscale or data.


===Analysis window Model Cache pane===
===Synopsis===


Data that is used to create models and predictions during data analysis as well as all of the models and predictions created from this data is automatically cached. After a model is created, the model and the data used to create it are added to the cache. If new data is loaded and a prediction is made, this new data and the prediction are added to the cache. Every time you edit data and create a new model or prediction from the data, each version of the modified data and the corresponding model or prediction are added to the cache. The Model Cache pane displays this complete history of all your cached items-all of the data that was used to create models and predictions during data analysis as well as all of the models and predictions that were created from this data-in a hierarchical view.
: [ctypes, rtypes] = importtool(data);
: [ctypes, rtypes] = importtool(data,options);


:''Analysis window Model Cache pane''
===Description===


::[[Image:Model_cache_pane.png|247x288px]]
Allows user to identify data type (data, class, axisscale, include, and ignore) fields (row and columns) in a data matrix.


To reload a previously created model:
===Options===
# Set the Model Cache view to the mode which best organizes the list to help you find the item desired (see the [[AnalysisWindow_ModelCachepane#Model Cache pane view|Model Cache pane view]] descriptions for suggestions.)
# Locate the model to load in the list (Note that after other sorting criteria are met, models on a specific branch are sorted by date in all views.)
# Double-click on the old model to load it into the Analysis window. The calibration data corresponding to the model will also be automatically loaded (if it is available in the cache.) Right-clicking the model will give other options - see [[AnalysisWindow_ModelCachepane#Manipulating cached items|Manipulating cached items]].
For more usage hints, see the [[AnalysisWindow_ModelCachepane#Model Cache pane view|Model Cache pane view]] descriptions below.


'''Note:''' By default, the Model Cache pane is turned on when Solo first opens. You can close the Model Cache pane by clicking the Close ("X") button in the upper right hand corner of the pane. To turn the Model Cache on again, on the Tools menu on the Analysis window, click View Cache, and then select a viewing option. Models and data are cached even if the Model Cache pane is not open.
options = a structure array with the following fields:


Multiple options are available to you for changing the Model Cache view, managing your cache, and manipulating cache items. See:
* '''fields''': Nx2 cell array, first column is field name, second column is color to use.


* [[AnalysisWindow_ModelCachepane#Model Cache pane view|Model Cache pane view]].
* [[AnalysisWindow_ModelCachepane#Cache management|Cache management]].
* [[AnalysisWindow_ModelCachepane#Manipulating cached items|Manipulating cached items]].


===Model Cache pane view===
==Examples==


The options to change the Model Cache pane view are found in two locations:


* In the Model Cache pane itself under Cache Settings and View
Here we import a csv file by dragging the file into the browse window. 
* On the Tools menu (the View Cache option) for the Analysis windows


:''Options to change the Model Cache pane view''
Taking a look at the file we are attempting to import, we see that we have 4 lines of meta data + blank lines, so we set the 'header rows' field to 4 in the text import settings window.  The automatic delimiter detection is being used in this example, however the user may force the use of a specific delimiter by selecting it in this window.   


::[[Image:Model_cache_settings_options.png|171x56px]]


You can select from three different organizational views:
[[Image:csv_examp.jpg||460px|]]
[[Image:Text_import1.jpg||360px|]]


* View Cache by Lineage-In the View Cache by Lineage view, the cache items are sorted by the parent data item. Under the parent data item, the child items (modified data, model, and predictions) are sorted by the timestamps at each modification point.
: This is a convenient view to use in identifying a set of models which were all created from a specific data set or ''version'' of a data set (such as a specific data set with different sets of included variables and/or samples.)


:''View Cache by Lineage view''


::[[Image:Model_cache_view_lineage.png|247x288px]]


* View Cache by Date-In the View Cache by Date view, all cached items are simply sorted by creation date in chronological order.
The importool will attempt to automatically detect label columns.  Here the first column containing the names of beers has been automatically detected as a label column.  The third column, containing class information of either 'ale' or 'lager' has also been automatically detected as a label column. To set this column to a class column, click where it says 'label' underneath C2 and select class. The importer will now populate the datasets'class field with the information contained within this second column.  
: This is a convenient view to use when attempting to locate a model or data which was used on a specific date. For example, to reload a model which you knew was built yesterday, switch to the Date view, locate yesterday's date, and expand the tree. All data and models used on that day will be listed. Reload any model by double-clicking it.


:''View Cache by Date view''


::[[Image:Model_cache_view_date.png|247x288px]]


* View Cache by Type-In the View Cache by Type view, all cached items are simply sorted by object type-data, model, or prediction.
[[Image:importtool1.jpg||420px|]]
: This is a convenient view to use when attempting to locate a specific type of model when the data used and model's created date are not known. All data, models, and predictions are listed under their own branch, and then sorted by name (for data), type (for models and predictions), and date. For example, to locate an MCR model you know you created on some previous date, switch to the Type view, expand the Models branch, and locate the MCR models in that branch. You can then reload any model by double-clicking it.


:''View Cache by Type view''


::[[Image:Model_cache_view_type.png|247x288px]]


===Cache management===
===See Also===


Several options are available to you for managing your cache. You can modify all of these options in the Options dialog box.
[[parsemixed]]
 
'''Note:''' For a detailed discussion about the Options dialog box, see [[Solo_CommonApplicationFeatures|Options dialog box]].
 
{|
 
|- valign="top"
 
|1.
 
|Do one of the following:
 
|}
 
{| style="margin-left:18pt" 
 
|- valign="top"
 
|
* In the Model Cache pane, expand the Cache Settings and View option, and under this option, click Edit Model Cache Settings.
 
|}
 
:''Cache Settings and View options''
 
::[[Image:Edit_Model_Cache_settings_paneoptions.png|232x122px]]
::
 
::
::
 
{| style="margin-left:18pt" 
 
|- valign="top"
 
|
* On the Analysis window menu, click Edit > Options > Model Cache Settings.
 
|}
 
::The Options dialog box for the Model Cache pane opens.
 
:''Options dialog box''
 
::[[Image:Options_Model_Cache_dialogbox.png|650px]]
::
 
::
::
 
{|
 
|- valign="top"
 
|2.
 
|Modify the value for any option, and then click OK.
 
|}
 
:The Options dialog box closes and you return to the Model Cache pane. Any changes that you made are effective immediately.
 
::
::
<table style="border-collapse: collapse; margin-bottom: 12.0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 3.0pt; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; text-align: left; width: 465.75144pt;" cellspacing="0" summary="">
 
<tr>
<td style="background-color: #E8E8E8; border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top; width: 97.50024pt;">
 
'''Option'''
</td>
<td style="background-color: #E8E8E8; border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top; width: 368.2512pt;">
 
'''Description'''
</td>
</tr>
<tr>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
cache
</td>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Controls the operation of the cache. "On" records all data, models, and predictions. "readonly" locks down the cache and prevents recording to the cache and clearing of the cache.
</td>
</tr>
<tr>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
project
</td>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Specifies an optional subfolder within the cachefolder for holding the cached items. The default name for project is "general." You can use the project setting to separate cached items among different work projects.
'''Note: '''No option is available in Solo to delete a project folder after you create it. You can delete old project folders only by manually locating the project folder on your computer and deleting the folder.
'''Note:''' You can also change value for the project setting using the Change Project option under Cache Settings and View in the Model Cache pane.
</td>
</tr>
<tr>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
maxage
</td>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
The maximum number of days an item is saved in the cache. An item that is older than this value is permanently deleted from the cache.
'''Note:''' See [[AnalysisWindow_ModelCachepane#Manipulating cached items|"Manipulating cached items"]] below for information about saving cached items to a location other than the cachefolder.
</td>
</tr>
<tr>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
maxdatasize
</td>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Specifies the maximum size of a data item (in total number of table elements) that can be stored in the cache.
</td>
</tr>
</table>
 
===Manipulating cached items===
 
You can right-click on an entry for a cached item Model Cache pane to open a context menu that contains options for manipulating the item.
 
::
::
<table style="border-collapse: collapse; margin-bottom: 12.0pt; margin-left: 0pt; margin-right: 0pt; margin-top: 3.0pt; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; text-align: left; width: 405.75096pt;" cellspacing="0" summary="">
 
<tr>
<td style="background-color: #E8E8E8; border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top; width: 108.75024pt;">
 
'''Menu Option'''
</td>
<td style="background-color: #E8E8E8; border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top; width: 297.00072pt;">
 
'''Description'''
</td>
</tr>
<tr>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Load Item
</td>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Loads the selected cached item into the Analysis window. By default, if no data is loaded into the Analysis window, then the cached item is loaded into the X calibration component; otherwise, you are prompted to override the loaded data or load the data to another location.
'''Note:''' You can also double-click a cached item to load it into the Analysis window.
</td>
</tr>
<tr>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Show Item
</td>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Opens and displays the selected item in a separate window-either the DataSet Editor window or the Model Reader window.
</td>
</tr>
<tr>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Save Cached Item As
</td>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Save the cached item to the workspace or to a file.
</td>
</tr>
<tr>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Open in New Window
</td>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Opens the cached item in a new Analysis window.
</td>
</tr>
<tr>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Rename
</td>
<td style="border-bottom-color: #000000; border-bottom-style: solid; border-bottom-width: 1px; border-left-color: #000000; border-left-style: solid; border-left-width: 1px; border-right-color: #000000; border-right-style: solid; border-right-width: 1px; border-top-color: #000000; border-top-style: solid; border-top-width: 1px; padding-bottom: 1pt; padding-left: 6pt; padding-right: 6pt; padding-top: 6pt; vertical-align: top;">
Rename the cached item.
</td>
</tr>
</table>
 
===Moving/Changing a Cache===
 
You can copy and move your Model Cache folder to a new location without any special consideration. When moving to a new computer, copy the cache folder to the new EVRI [[evridir | home folder]] and restart Matlab. Once the folder is in the new location select '''File/Change Cache''' from the Workspace Browser and select the new folder. The cache will refresh automatically.
 
From the Workspace Browser '''File>Change Cache''' menu item. From the Matlab command line the cache folder location can be change with:
 
modelcache('changecachedir','path/to/new/location')
 
If you move your modelcache and experience problems getting the Model Cache to recognize the new location you may need to clear your preferences (matlabprefs.mat) file. Contact helpdesk@eigenvector.com for more details on how to do this.
 
===Exporting and Importing Models===
 
Models can be exported from the cache via the right-click menu '''Export For Cache''' item. This will export the model and the data used to create it (if available) to a MAT file. The file can then be Imported into a different cache. To import a cache model, expand the Cache Settings and View leaf and click the '''Import Model' leaf.

Revision as of 12:50, 27 October 2016

Purpose

GUI for designating column/row data types in incoming data. Allows user to specify a column or row as labels, class sets, or axisscale or data.

Synopsis

[ctypes, rtypes] = importtool(data);
[ctypes, rtypes] = importtool(data,options);

Description

Allows user to identify data type (data, class, axisscale, include, and ignore) fields (row and columns) in a data matrix.

Options

options = a structure array with the following fields:

  • fields: Nx2 cell array, first column is field name, second column is color to use.


Examples

Here we import a csv file by dragging the file into the browse window.

Taking a look at the file we are attempting to import, we see that we have 4 lines of meta data + blank lines, so we set the 'header rows' field to 4 in the text import settings window. The automatic delimiter detection is being used in this example, however the user may force the use of a specific delimiter by selecting it in this window.


Csv examp.jpg Text import1.jpg



The importool will attempt to automatically detect label columns. Here the first column containing the names of beers has been automatically detected as a label column. The third column, containing class information of either 'ale' or 'lager' has also been automatically detected as a label column. To set this column to a class column, click where it says 'label' underneath C2 and select class. The importer will now populate the datasets'class field with the information contained within this second column.


Importtool1.jpg


See Also

parsemixed