Size: 5937
Comment:
|
Size: 6915
Comment:
|
Deletions are marked like this. | Additions are marked like this. |
Line 1: | Line 1: |
= Semantic Network Summary Parameter Tutorial = | ## page was renamed from GSoC2010_ParameterTutorial #acl All:read LaylaOesper:write,delete,revert = WordCloud Parameter Tutorial = |
Line 3: | Line 5: |
This tutorial will guide a user through how to use and manipulate the parameters associated with the Semantic Network Summary plugin using the Cytoscape session file provided. See the Semantic Summary [[GSoC2010_UseExamples|Basic Tutorial]] for an introduction to using the Semantic Network Summary. | This tutorial will guide a user through how to use and manipulate the parameters associated with the WordCloud app using the Cytoscape session file provided. See the WordCloud [[Software/WordCloudPlugin/BasicTutorial|Basic Tutorial]] for an introduction to using the basic functionality of the WordCloud plugin. |
Line 7: | Line 9: |
* Cytoscape >= 2.6.3 must be installed * The Semantic Network Summary plugin must be in the Cytoscape-v2.x.x/plugins folder |
* Cytoscape >= 3.1 must be installed * The WordCloud plugin must be in the CytoscapeConfiguration/3/apps/installed folder |
Line 11: | 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 14: | Line 16: |
=== Version 0.5 or newer === | === WordCloud Version 3.0.1 or newer === |
Line 17: | 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 25: | Line 27: |
4. Create a cloud using the nodes already selected in the nodes already pre-selected in the network. Change the node attribute used for the semantic analysis to EM1_GS_DESCR and update the cloud. From here forth we will refer to this as the "Original Cloud". | 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. A WordCloud is automatically created in the WordCloud display panel. |
Line 31: | Line 35: |
5. Expand the Advanced parameters section of the Input Panel. Change the '''Max Num of Words''' from the default of 250 to 5 and create a new cloud. This will cause only the top 5 most significant words to appear in your cloud. | 6. Expand the Advanced section of the Input Panel. Change the '''Max Num of Words''' from the default of 250 to 5. This will cause only the top 5 most significant words to appear in your cloud. |
Line 33: | Line 37: |
* Word significance is determined by the size of the word. If you have cloud display style selected that includes clustering (which you do for this example) ties are broken using cluster membership. Also, notice that clusters are organized by decreasing order of importance where importance is determined using both the number of words appearing in a cluster as well as their size. | * Word significance is correlated directly with the size of the word in the display. If you have cloud display style selected that includes clustering (which you do for this example) ties are broken using cluster membership. Also, notice that clusters are organized by decreasing order of importance where importance is determined using both the number of words appearing in a cluster as well as their size. |
Line 39: | Line 43: |
6. Select the original cloud from your list of clouds. Change the '''Network Normalization '''from 1 to 0 and create a new cloud. | 7. Set '''Max Num of Words''' back to 250. |
Line 41: | Line 45: |
* In the original cloud having the Network Normalization set to 1 meant that the size that words appear in the cloud is directly proportional to the ratio of how often the word appears in the selected nodes over how often it appears in the whole network. Setting the Network Normalization to 0 means that the size that the words appear in the cloud is directly proportional to how often they appear in the selected nodes - no weight is given to how often they appear in the whole network. In this example, Cancer is the largest word in the cloud, which means that it is the most frequently appearing word in the selected nodes. * Since changing the Network Normalization parameter affects the relative importance for each word, changing its value also affects how clustering occurs. A user should expect that changing this parameter will likely change how the words for a cloud are clustered. '''Expected Result:''' ''' {{attachment:Network_Normalization.png|Network_Normalization.jpg}} ''' 7. Select the original cloud from you list of clouds. Change the '''Word Aggregation Cutoff '''from 1 to 50 and create a new cloud. |
8. Change the '''Word Aggregation Cutoff '''from 1 to 50. |
Line 52: | Line 49: |
* In general, a lower Word Aggregation Cutoff value (minumum of 0) means that the requirements for clustering are less stringent and as a result there will be fewer, larger clusters. However, since our clustering algorithm takes into account the order that the words appear, it is unlikely that a Word Aggregation Cutoff value of 0 will result in a single large cluster. | * In general, a lower Word Aggregation Cutoff value (minumum of 0) means that the requirements for clustering are less stringent and as a result there will be fewer, larger clusters. However, since our clustering algorithm takes into account the order that the words appear, it is unlikely that a Word Aggregation Cutoff value of 0 will result in a single large cluster. |
Line 58: | Line 55: |
8. Select the original cloud from your list of clouds. In the '''Word Exclusion List''' section of the input panel add the word "cancer" to be excluded (hit the add button after typing the word). Create a new cloud. | 9. Set '''Word Aggregation Cutoff ''' back to 1. |
Line 60: | Line 57: |
* The word cancer will no longer appear in the newly created cloud. | 10. Previously, the size of words in the word tag cloud was based entirely on the selected nodes. The Normalization slider allows the size of words to be calculated also using the make-up of the entire network. Try dragging the slider bar all the way from 0.0 to 1.0 and watch how the word tag cloud changes in real time. * Setting the Normalization to 0 means that the size that the words appear in the cloud is directly proportional to how often they appear in the selected nodes - no weight is given to how often they appear in the whole network. In this example, Cancer is the largest word in the cloud, which means that it is the most frequently appearing word in the selected nodes. * Since changing the Normalization parameter affects the relative importance for each word, changing its value also affects how clustering occurs. A user should expect that changing this parameter will likely change how the words for a cloud are clustered. '''Expected Result with Network Normalization = 1.0:''' ''' {{attachment:Network_Normalization.png|Network_Normalization.jpg}} ''' 11. Set Normalization back to 0.0 12. In the '''Cloud Style ''' combo box select Clustered-Boxes as the Cloud Style. '''Expected Result:''' ''' {{attachment:Boxes.png|Boxes.jpg}} ''' 13. In the '''Cloud Style ''' combo box select No-Clustering as the Cloud Style. '''Expected Result:''' {{attachment:No_Clustering.png|No_Clustering.jpg}} 14. Click the '''Excluded Words''' button, a dialog will pop-up. Add the word "cancer" to be excluded (hit the add button after typing the word) then click ok. * The word cancer will no longer appear in the cloud. |
Line 66: | Line 89: |
9. Select the original cloud from your list of clouds. In the '''Word Exclusion List''' section of the input panel expand the word removal list. Under the section with the heading --Flagged Words-- select the word "kegg". Hit the Remove button and create a new cloud. | 15. Open the Excluded Words dialog again. Click on the word "cancer" then click Remove. 16. Under the section with the heading --Flagged Words-- select the word "kegg". Hit the Remove button and then click ok. |
Line 75: | Line 100: |
10. Select the original cloud from your list of clouds. In the '''Cloud Layout '''section of the input panel select Clustered-Boxes and create a new cloud. | 17. Click the '''Delimeters''' button, a dialog will appear.. Under the section with the heading --Common Delimiter-- select the "space" option. Hit the Remove button then click Ok. |
Line 77: | Line 102: |
* Notice that the changes to the Word Exclusion List are still in effect. | * The space marker is no longer used as a word delimiter when doing tokenization. As a result you can create you cloud based on word phrases. |
Line 81: | Line 106: |
''' {{attachment:Boxes.png|Boxes.jpg}} ''' | ''' {{attachment:Remove_Space_Delim.png}} ''' |
Line 83: | Line 108: |
11. Select the original cloud from your list of clouds. In the '''Cloud Layout '''section of the input panel select No-Clustering and create a new cloud. | 18. Add the space character back to be used for tokenization. |
Line 85: | Line 110: |
* Notice that the changes to the Word Exclusion List are still in effect. | 19. Click the Enable Stemming checkbox. |
Line 87: | Line 112: |
'''Expected Result:''' | * Words are now all mapped to their stem using the Porter Stemming Algorithm. This will allow words like "cell" and "cells" to both be mapped to their common stem "cell" in the cloud display. * However, the user should notice that the stem chosen for a word may be somewhat unexpected. For example, in the cloud used thoughout this tutorial the word "endometrial" will now be displayed as "endometri" because the ending suffix has been removed in orde to isolate the word stem. Also, the word "pathway" is now represented with the stem "pathwai". |
Line 89: | Line 115: |
{{attachment:No_Clustering.png|No_Clustering.jpg}} | '''Expected Result:'''''' ''' ''' {{attachment:stemmingExample.png}} ''' |
WordCloud Parameter Tutorial
Outline
This tutorial will guide a user through how to use and manipulate the parameters associated with the WordCloud app using the Cytoscape session file provided. See the WordCloud Basic Tutorial for an introduction to using the basic functionality of 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
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. A WordCloud is automatically created in the WordCloud display panel.
Expected Original Cloud:
6. Expand the Advanced section of the Input Panel. Change the Max Num of Words from the default of 250 to 5. This will cause only the top 5 most significant words to appear in your cloud.
- Word significance is correlated directly with the size of the word in the display. If you have cloud display style selected that includes clustering (which you do for this example) ties are broken using cluster membership. Also, notice that clusters are organized by decreasing order of importance where importance is determined using both the number of words appearing in a cluster as well as their size.
Expected Result:
7. Set Max Num of Words back to 250.
8. Change the Word Aggregation Cutoff from 1 to 50.
- Setting the Word Aggregation Cutoff to 50 for this cloud places this value higher than the word aggregation value for all pairs of words that appear in the selected nodes. As a result, each word will be in its own cluster for this example.
- In general, a higher Word Aggregation Cutoff value means that the requirements for clustering are more stringent and as a result there will be more, smaller clusters.
- In general, a lower Word Aggregation Cutoff value (minumum of 0) means that the requirements for clustering are less stringent and as a result there will be fewer, larger clusters. However, since our clustering algorithm takes into account the order that the words appear, it is unlikely that a Word Aggregation Cutoff value of 0 will result in a single large cluster.
Expected Result:
9. Set Word Aggregation Cutoff back to 1.
10. Previously, the size of words in the word tag cloud was based entirely on the selected nodes. The Normalization slider allows the size of words to be calculated also using the make-up of the entire network. Try dragging the slider bar all the way from 0.0 to 1.0 and watch how the word tag cloud changes in real time.
- Setting the Normalization to 0 means that the size that the words appear in the cloud is directly proportional to how often they appear in the selected nodes - no weight is given to how often they appear in the whole network. In this example, Cancer is the largest word in the cloud, which means that it is the most frequently appearing word in the selected nodes.
- Since changing the Normalization parameter affects the relative importance for each word, changing its value also affects how clustering occurs. A user should expect that changing this parameter will likely change how the words for a cloud are clustered.
Expected Result with Network Normalization = 1.0:
11. Set Normalization back to 0.0
12. In the Cloud Style combo box select Clustered-Boxes as the Cloud Style.
Expected Result:
13. In the Cloud Style combo box select No-Clustering as the Cloud Style.
Expected Result:
14. Click the Excluded Words button, a dialog will pop-up. Add the word "cancer" to be excluded (hit the add button after typing the word) then click ok.
- The word cancer will no longer appear in the cloud.
Expected Result:
15. Open the Excluded Words dialog again. Click on the word "cancer" then click Remove.
16. Under the section with the heading --Flagged Words-- select the word "kegg". Hit the Remove button and then click ok.
- The word "kegg" is no longer being filtered out and will now appear in the word tag cloud.
- Since the word exclusion list is stored at the network level, the word "cancer" will continue to no longer appear in the newly created cloud.
Expected Result:
17. Click the Delimeters button, a dialog will appear.. Under the section with the heading --Common Delimiter-- select the "space" option. Hit the Remove button then click Ok.
- The space marker is no longer used as a word delimiter when doing tokenization. As a result you can create you cloud based on word phrases.
Expected Result:
18. Add the space character back to be used for tokenization.
19. Click the Enable Stemming checkbox.
- Words are now all mapped to their stem using the Porter Stemming Algorithm. This will allow words like "cell" and "cells" to both be mapped to their common stem "cell" in the cloud display.
- However, the user should notice that the stem chosen for a word may be somewhat unexpected. For example, in the cloud used thoughout this tutorial the word "endometrial" will now be displayed as "endometri" because the ending suffix has been removed in orde to isolate the word stem. Also, the word "pathway" is now represented with the stem "pathwai".
Expected Result: