Difference between revisions of "Preferences"
(→Introduction) |
(→Mac OSX Example) |
||
(22 intermediate revisions by 2 users not shown) | |||
Line 4: | Line 4: | ||
The Preferences item in the menu bar allows a number of features of geWorkbench to be configured. | The Preferences item in the menu bar allows a number of features of geWorkbench to be configured. | ||
− | [[Image: | + | [[Image:MenuBar_Preferences.png|{{ImageMaxWidth}}]] |
+ | ==When do changes take effect?== | ||
− | + | Changes to items in the preferences menu do not affect any already present primary data nodes, e.g. microarray data sets. The changes will be in force for any new data nodes loaded after a setting is changed. They will also take effect if geWorkbench is restarted. | |
==Text Editor== | ==Text Editor== | ||
− | The user can change the default text editor used to view data files. For example, when you right-click on a data node in the | + | The user can change the default text editor used to view data files. For example, when you right-click on a data node in the [[Workspace]], "View in Editor" is one of the options offered. |
− | |||
==Visualization== | ==Visualization== | ||
Line 57: | Line 57: | ||
==Remote Workspaces URL== | ==Remote Workspaces URL== | ||
− | Development versions of geWorkbench have a feature which allows a | + | Development versions of geWorkbench have a feature which allows a [[Workspace]] to be saved to a remote server for later retrieval or sharing. |
+ | |||
+ | ==Soft Limit on Cytoscape Networks Objects== | ||
+ | |||
+ | There is a limit to the size of networks that Cytoscape can be used to visualize in geWorkbench. This limit will depend on the amount of memory allocated to geWorkbench. Viewing too large a network can cause geWorkbench to run out of memory and stop responding. | ||
+ | |||
+ | As of release 2.2.1, if the user attempts to view a large network in Cytocape, he or she will be offered the option to instead view the network using a built-in text viewer. | ||
+ | |||
+ | This "Soft Limit" preference setting controls the size of a network, calculated at the sum of the node (genes) and edges (interactions), that will trigger display of the dialog allowing the user to choose the text viewer. The user can experiment with attempting to view larger networks. | ||
+ | |||
+ | See the [[Cytoscape_Network_Viewer | Cytoscape Network Viewer]] chapter for further details. | ||
+ | |||
+ | ==R Location (Rscript.exe and its folder)== | ||
+ | Several geWorkbench components can make calls to a locally installed version of R. This field must contain the complete path to the R executable Rscript.exe. | ||
+ | |||
+ | Please see [[Download_and_Installation#R_Installation_for_geWorkbench | R Installation for geWorkbench]] for important details on how to install R for use by geWorkbench. | ||
+ | |||
+ | ===Windows examples=== | ||
+ | If R is installed to the system directory, the complete entry may appear as shown here (C:\Program Files\R\R-3.1.2\bin\Rscript.exe: | ||
+ | |||
+ | [[Image:RScript_location_system.png]] | ||
+ | |||
+ | ===Mac OSX Example=== | ||
+ | |||
+ | Macintosh OSX users should install R in the usual default directory "Application". The path to the Rscript location becomes, e.g. for version 3.1: /Library/Frameworks/R.framework/Versions/3.1/Resources/Rscript. | ||
+ | |||
+ | [[Image:Mac_OSX_Rscript_location.png]] | ||
+ | |||
+ | The path to the R package directory can be left empty, however the packages will be installed in e.g. /Library/Frameworks/R.framework/Versions/3.0/Resources/library. | ||
+ | |||
+ | ==R package directory== | ||
+ | Intended to hold the path to an alternate R package directory. If a value is entered here, geWorkbench will download needed R packages to the folder entered. The folder should already exist. This is especially useful if R was installed to a system directory which does not allow direct updates of R packages. | ||
+ | |||
+ | * Setting a value in this field overrides any value you may have set in the environment variable R_LIBS_USER. | ||
+ | |||
+ | * The package directory path should not end in a "/" or "\" character. geWorkbench will remove it if present. |
Latest revision as of 16:49, 30 January 2015
Contents
Introduction
The Preferences item in the menu bar allows a number of features of geWorkbench to be configured.
When do changes take effect?
Changes to items in the preferences menu do not affect any already present primary data nodes, e.g. microarray data sets. The changes will be in force for any new data nodes loaded after a setting is changed. They will also take effect if geWorkbench is restarted.
Text Editor
The user can change the default text editor used to view data files. For example, when you right-click on a data node in the Workspace, "View in Editor" is one of the options offered.
Visualization
Heat maps, e.g. in the Color Mosaic component, can be displayed using either a relative or an absolute color scheme.
A change in this setting only takes effect the next time a new microarray data node is loaded. It does not affect the visualization of any node already loaded.
Note - Changing the relative/absolute preference will not take effect until the next time a data set is loaded.
- Absolute
- Red represents positive expression values, and green represents negative expression values. Black represents a value of zero. The shade represents the expression magnitude as follows:
- Formal spec: Let M = max{|min|, |max|} over all expression measurements, across all arrays. If expression value x > 0, assign it the red spectrum x / M * 256. If expression value x is negative, assign it to the green spectrum -x / M * 256.
- Relative (default)
- Relative is similar to the setting for Absolute, but each marker is mean-variance normalized first. A Red-Blue color scheme is used, with red representing the highest values and blue the lowest. White represents the marker average.
- Note - Relative will give odd-looking results if only a small number of arrays are loaded.
GenePix Value Computation
Four methods for calculating a composite expression measurement for each marker in a GenePix file are offered. They combine the foreground and background and mean or median measurements from each channel in different ways.
- ( F635 Mean - B635 Mean) / (F532 Mean - B532 Mean).
- ( F635 Median - B635 Median) / (F532 Median - B532 Median).
- ( F532 Mean - B532 Mean) / (F635 Mean - B635 Mean).
- ( F532 Median - B532 Median) / (F635 Median - B635 Median).
See the entry GenePix Format in the GenePix tutorial chapter for further details of processing GenePix data on input.
Remote Components URL
geWorkbench can download certain components from a network repository. This specifies the location of the network component repository.
Marker Load Options
When a microarray dataset is loaded, along with its annotation file, it is possible to re-sort the markers at the global level - the new order will then be seen in all geWorkbench components. There are three options:
- Load markers in the original order
- Load markers ordered by gene name
- Load markers ordered by probeset id
If no annotation file is loaded, sorting by probeset id can still be done.
If the Marker Load option is changed, it will take effect the next time a dataset is loaded.
In addition to this global sorting, markers can also be sorted by the same three methods in the Markers component (right-click on the marker list).
Remote Workspaces URL
Development versions of geWorkbench have a feature which allows a Workspace to be saved to a remote server for later retrieval or sharing.
Soft Limit on Cytoscape Networks Objects
There is a limit to the size of networks that Cytoscape can be used to visualize in geWorkbench. This limit will depend on the amount of memory allocated to geWorkbench. Viewing too large a network can cause geWorkbench to run out of memory and stop responding.
As of release 2.2.1, if the user attempts to view a large network in Cytocape, he or she will be offered the option to instead view the network using a built-in text viewer.
This "Soft Limit" preference setting controls the size of a network, calculated at the sum of the node (genes) and edges (interactions), that will trigger display of the dialog allowing the user to choose the text viewer. The user can experiment with attempting to view larger networks.
See the Cytoscape Network Viewer chapter for further details.
R Location (Rscript.exe and its folder)
Several geWorkbench components can make calls to a locally installed version of R. This field must contain the complete path to the R executable Rscript.exe.
Please see R Installation for geWorkbench for important details on how to install R for use by geWorkbench.
Windows examples
If R is installed to the system directory, the complete entry may appear as shown here (C:\Program Files\R\R-3.1.2\bin\Rscript.exe:
Mac OSX Example
Macintosh OSX users should install R in the usual default directory "Application". The path to the Rscript location becomes, e.g. for version 3.1: /Library/Frameworks/R.framework/Versions/3.1/Resources/Rscript.
The path to the R package directory can be left empty, however the packages will be installed in e.g. /Library/Frameworks/R.framework/Versions/3.0/Resources/library.
R package directory
Intended to hold the path to an alternate R package directory. If a value is entered here, geWorkbench will download needed R packages to the folder entered. The folder should already exist. This is especially useful if R was installed to a system directory which does not allow direct updates of R packages.
- Setting a value in this field overrides any value you may have set in the environment variable R_LIBS_USER.
- The package directory path should not end in a "/" or "\" character. geWorkbench will remove it if present.