Size: 3568
Comment:
|
← Revision 22 as of 2015-04-17 19:35:20 ⇥
Size: 3389
Comment:
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
## page was renamed from GSoC2010_UseExamples | |
Line 2: | Line 3: |
= WordCloud Plugin Basic Tutorial = | = WordCloud Quick Start Tutorial = |
Line 4: | Line 5: |
This tutorial will guide a user through the basic functioning of the WordCloud plugin using the Cytoscape session file provided. See the WordCloud [[GSoC2010_ParameterTutorial|Parameter Tutorial]] for a more detailed examples on using and changing the parameters available for the WordCloud Plugin. | This tutorial will guide a user through the basic functioning of the WordCloud plugin using the Cytoscape session file provided. See the WordCloud [[Software/WordCloudPlugin/ParameterTutorial|Parameter Tutorial]] for a more detailed examples on using and changing the parameters available for the WordCloud Plugin. |
Line 8: | Line 9: |
* Cytoscape >= 2.6.3 must be installed * The WordCloud plugin must be in the Cytoscape-v2.x.x/plugins folder * Download the test data |
* Cytoscape >= 3.1 must be installed * The WordCloud plugin must be in the CytoscapeConfiguration/3/apps/installed folder * Download the test data (AlzheimerEM.cys) |
Line 12: | Line 13: |
Go to this page to [[GSoC2010_SoftwareDownload|download the plugin and test data]] | Go to this page to [[Software/WordCloudPlugin|download the plugin and test data]] |
Line 15: | Line 16: |
=== Version 0.5 or newer === | === WordCloud Version 3.0.1 or newer === |
Line 18: | Line 19: |
2. Open the provided [[GSoC2010_SoftwareDownload|sample data file]] (File / Open / select the file AlzheimerEM.cys) | 2. Open the provided [[Software/WordCloudPlugin|sample data file]] (File / Open / select the file AlzheimerEM.cys) |
Line 26: | Line 27: |
4. Click on Plugins / WordCloud / Settings - this will bring up the WordCloud Input and Display panels. | 4. In the main menu select Apps > WordCloud > Show WordCloud - this will bring up the WordCloud Input and Display panels. |
Line 28: | Line 29: |
5. In the Attribute Choice section of the Input panel change the attribute used from nodeID to EM1_GS_DESCR. This will change what node attribute is used when performing the semantic analysis and creating the cloud. For now you can leave all other values at their defaults. | 5. Under "Current Values" in the Input panel change the selected attributes to just EM1_GS_DESCR. This will change what node attribute are used when performing the semantic analysis and creating the cloud. For now you can leave all other values at their defaults. A WordCloud is automatically created in the WordCloud display panel. |
Line 30: | Line 31: |
6. Create a new cloud using one of the following three options: A. Right click on one of the nodes in the network and select the option for "Create Cloud" A. Click on Plugins / WordCloud / Create Cloud A. Click on the Create button on the bottom right corner of the WordCloud Input panel. |
6. To save the state of the word cloud click on the [+] button in the input panel. This will save the cloud under the name "Cloud_1". |
Line 40: | Line 37: |
7. Right click on the cloud in the list of clouds and choose "Edit Cloud Name". Provide a new name for the cloud that is not a duplicate of a name already given to any clouds for this network and select OK. | 7. Right click on the cloud in the list of clouds and choose "Rename Cloud". Provide a new name for the cloud that is not a duplicate of a name already given to any clouds for this network and select OK. |
Line 42: | Line 39: |
8. Expand the Advanced Parameters section of the Input panel by clicking on the black triangle next to the section name. Change Network Normalization value to 1. For a more detailed example on how the parameters affect the word tag clouds, see the Parameter Tutorial. | 8. Expand the Advanced section of the Input panel by clicking on the black triangle next to the section name. Change 'Max Num of Words' from 250 to 5. For a more detailed example on how the parameters affect the word tag clouds, see the Parameter Tutorial. |
Line 44: | Line 41: |
9. Click on the Update button to update the cloud to reflect the parameter change. | 9. The cloud automatically updates to reflect the parameter change. |
Line 48: | Line 45: |
* If you have changed the set of selected nodes from when the cloud was originally created or last updated a warning will appear at this time. The warning will ask if you want to use the set of currently selected nodes, or if you want to revert back to last set of selected nodes. | |
Line 52: | Line 48: |
''' {{attachment:Updated_Cloud.png|Updated_Cloud.jpg}} ''' | ''' {{attachment:Max_Word_Cloud.png}} <<BR>> ''' |
Line 62: | Line 58: |
12. With the cloud highlighted, choose the Delete button from bottom of the input panel to remove the cloud from your list of clouds. | 12. With the cloud highlighted go to Apps > WordCloud > Export Cloud Image in the main menu. This will allow you to save the image of the cloud as a PNG file. 13. Right click on the cloud name and select Delete to remove the cloud from your list of clouds. |
WordCloud Quick Start Tutorial
Outline
This tutorial will guide a user through the basic functioning of the WordCloud plugin using the Cytoscape session file provided. See the WordCloud Parameter Tutorial for a more detailed examples on using and changing the parameters available for the WordCloud Plugin.
Pre-requisites -
Cytoscape >= 3.1 must be installed
The WordCloud plugin must be in the CytoscapeConfiguration/3/apps/installed folder
- Download the test data (AlzheimerEM.cys)
Go to this page to download the plugin and test data
Instructions
WordCloud Version 3.0.1 or newer
1. Open Cytoscape
2. Open the provided sample data file (File / Open / select the file AlzheimerEM.cys)
3. Be careful not to change the set of selected nodes for the network titled "EM1_Enrichment Map" as this will change the results that you will get.
The example network with the correct set of nodes selected:
4. In the main menu select Apps > WordCloud > Show WordCloud - this will bring up the WordCloud Input and Display panels.
5. Under "Current Values" in the Input panel change the selected attributes to just EM1_GS_DESCR. This will change what node attribute are used when performing the semantic analysis and creating the cloud. For now you can leave all other values at their defaults. A WordCloud is automatically created in the WordCloud display panel.
6. To save the state of the word cloud click on the [+] button in the input panel. This will save the cloud under the name "Cloud_1".
Expected Result:
7. Right click on the cloud in the list of clouds and choose "Rename Cloud". Provide a new name for the cloud that is not a duplicate of a name already given to any clouds for this network and select OK.
8. Expand the Advanced section of the Input panel by clicking on the black triangle next to the section name. Change 'Max Num of Words' from 250 to 5. For a more detailed example on how the parameters affect the word tag clouds, see the Parameter Tutorial.
9. The cloud automatically updates to reflect the parameter change.
- The Update functionality only applies to the cloud currently selected from the list of clouds in the top section of the Input panel.
Expected Result:
10. In the word cloud, click on the word "Cancer" to see all the nodes in the network that contain this word become highlighted.
The example network with all nodes containing the word Cancer in the attribute EM1_GS_DESCR highlighted:
11. Click on the cloud in the cloud list on the top section of the Input panel to re-select the set of selected nodes that the cloud was built from.
12. With the cloud highlighted go to Apps > WordCloud > Export Cloud Image in the main menu. This will allow you to save the image of the cloud as a PNG file.
13. Right click on the cloud name and select Delete to remove the cloud from your list of clouds.