Deprecated: Methods with the same name as their class will not be constructors in a future version of PHP; GeSHi has a deprecated constructor in /var/www/vhosts/rave.gatech.edu/httpdocs/help/extensions/SyntaxHighlight_GeSHi/geshi/geshi.php on line 259

Warning: Parameter 1 to SyntaxHighlight_GeSHi::configureParser() expected to be a reference, value given in /var/www/vhosts/rave.gatech.edu/httpdocs/help/includes/Hooks.php on line 207

Warning: Parameter 1 to SyntaxHighlight_GeSHi::resourceLoaderRegisterModules() expected to be a reference, value given in /var/www/vhosts/rave.gatech.edu/httpdocs/help/includes/Hooks.php on line 207
Difference between revisions of "Saving and Loading your Work" - Rave Documentation

Difference between revisions of "Saving and Loading your Work"

From Rave Documentation
Jump to: navigation, search
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
+
Rave offers two ways to save your work: Rave Projects, and Metadata. Use Rave Project (.rve) files to completely save your current Rave setup. Use Metadata files (.rvm) to only save supporting information related to your data set without saving the [[Workspace]] itself.
 
+
Rave offers two ways to save your work: Rave Projects, and Metadata.  
+
  
 
=Rave Projects=
 
=Rave Projects=
Line 30: Line 28:
  
 
=Metadata=
 
=Metadata=
 +
Metadata files contain additional information about your data that is not contained in the data file itself. When you load a [[data file]] in Rave, if a .rvm file with the same filename. is found in the same directory as the data file, it will be loaded simultaneously Metadata files can be exported from Rave, so the first time you use a particular data file, it will have no metadata. Rather, metadata provides a way for you to provide you with a more complete "starting point" for working with data sets that you use often.
 +
 +
If you had more than one [[Analysis]] when you exported the metadata, you will have the option of exporting metadata for all of the Analyses, or just one of them. Thus you can restore all of your Analyses automatically when loading a
 +
 +
'''Note: If you are working with a Rave Project file, you dont not also need to save a Rave Metadata file, since all of this information is already included in the Rave Project file.'''
 +
 +
The following types of information can be saved to a metadata file:
 +
*All information about [[Working with functions in Rave|user-supplied functions]] that have been associated with your data set. Thus when you load the data file, any related function files will also load automatically without the need for you to load them from the [[Model Tab]].
 +
*[[Constraints]] that you have created.
 +
*The [[Variable Color]] associated with each variable in the data set.
 +
*The marker color associated with each row in the data set, as well as whether the rows should be hidden or selected.
 +
*The [[Variable Type]] of each variable in the data set and its associated range (for continuous variables or allowable values (for discrete variables).
 +
*The [[Current Point]] at which [[Continuous Graphs]] are being drawn.
 +
*The [[Target Value]] and [[Preference Value]] for each variable in the data set.
 +
 +
The first time you use a particular data set, you won’t have any metadata (unless you manually create a .rvm file), but once you start doing things in RAVE like changing row colors or adding constraints, you can save metadata files so that next time you work with this data set you won’t need to redo all those things. Metadata is therefore something like a midway point between starting from scratch and saving the entire RAVE project. Metadata only saves the information listed below, not anything that is visible on the rave workspace (graphs, controls, etc). So if you start a new RAVE session and load a data set with metadata you’ll still start with a blank workspace, but your data state will be just like it was when you saved the metadata.
 +
 +
For information on editing the .rvm file, see [[Metadata file format]]

Revision as of 20:47, 12 November 2011

Rave offers two ways to save your work: Rave Projects, and Metadata. Use Rave Project (.rve) files to completely save your current Rave setup. Use Metadata files (.rvm) to only save supporting information related to your data set without saving the Workspace itself.

Rave Projects

A "Rave Project" is a saved copy of a Rave session. When it is opened, it will exactly restore your Rave session as it was at the moment it was saved. Rave Project files have the file extension .rve

Saving a project

A Rave project can be saved by clicking the "Save Project to File" button on the Manage Tab. Note that since this is currently the only way to save a project, it is impossible to save a project so that it opens in full screen mode or with a tab other than the Manage Tab displayed.

The new project will be saved in a directory under your Default Rave Directory.


Loading a project

There are three ways to open a saved project:

  1. In Windows, if you associated the .rve file type with Rave during the Rave Installation process, then you can double click .rve files to open them. If MATLAB is not running, this will open MATLAB.
  2. In MATLAB, you can type raveopen('<path/name of .rve file>') to open the file. (You need to include the quotes, but not the <> brackets)
  3. In Rave, click the "Load Project from File" button on the Manage Tab to open a file browser and select a .rve file to open.

Developer Issues

If you are interested in developing Rave plugins, you may want to read Working with .rve files for important information related to ensuring your plugins are compatible with saving as a .rve file.


Working with Projects that require User-Supplied Functions

Important: If you save a Rave Project as a .rve file and would like to distribute it or move it to a different computer, you may need to include some additional files. The .rve file contains your data (so there is no need to also distribute any original data set files that you had loaded, but it does NOT contain the files for any functions that you loaded from the Model Tab. Read the help article for Function files created by Rave and be sure to include those files whenever you wish to distribute your .rve Rave Project file.

(A future update will put a list of these files in the same directory as the .rve file for easy reference)

Metadata

Metadata files contain additional information about your data that is not contained in the data file itself. When you load a data file in Rave, if a .rvm file with the same filename. is found in the same directory as the data file, it will be loaded simultaneously Metadata files can be exported from Rave, so the first time you use a particular data file, it will have no metadata. Rather, metadata provides a way for you to provide you with a more complete "starting point" for working with data sets that you use often.

If you had more than one Analysis when you exported the metadata, you will have the option of exporting metadata for all of the Analyses, or just one of them. Thus you can restore all of your Analyses automatically when loading a

Note: If you are working with a Rave Project file, you dont not also need to save a Rave Metadata file, since all of this information is already included in the Rave Project file.

The following types of information can be saved to a metadata file:

  • All information about user-supplied functions that have been associated with your data set. Thus when you load the data file, any related function files will also load automatically without the need for you to load them from the Model Tab.
  • Constraints that you have created.
  • The Variable Color associated with each variable in the data set.
  • The marker color associated with each row in the data set, as well as whether the rows should be hidden or selected.
  • The Variable Type of each variable in the data set and its associated range (for continuous variables or allowable values (for discrete variables).
  • The Current Point at which Continuous Graphs are being drawn.
  • The Target Value and Preference Value for each variable in the data set.

The first time you use a particular data set, you won’t have any metadata (unless you manually create a .rvm file), but once you start doing things in RAVE like changing row colors or adding constraints, you can save metadata files so that next time you work with this data set you won’t need to redo all those things. Metadata is therefore something like a midway point between starting from scratch and saving the entire RAVE project. Metadata only saves the information listed below, not anything that is visible on the rave workspace (graphs, controls, etc). So if you start a new RAVE session and load a data set with metadata you’ll still start with a blank workspace, but your data state will be just like it was when you saved the metadata.

For information on editing the .rvm file, see Metadata file format