Cytoscape Wiki|
Size: 2087
Comment:
|
Size: 2625
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
|
Describe Cytoscape_3/AppDeveloper/Cytoscape_3_App_Cookbook here. |
|
| Line 4: | Line 2: |
| == About the cookbook == | = About the cookbook = |
| Line 13: | Line 11: |
| == How to use the cookbook? == | = How to use the cookbook? = |
| Line 24: | Line 22: |
| == The list of app examples in the cookbook == | = The list of app examples in the cookbook = |
| Line 28: | Line 26: |
| === How to add a tabbed Panel to Control panel? === | == How to add a tabbed Panel to Control panel? == |
| Line 30: | Line 28: |
| === How to add an image icon (menu item) to the toolbar? === | == How to add an image icon (menu item) to the toolbar? == |
| Line 38: | Line 36: |
| == Trouble shooting == | = Trouble shooting = |
| Line 46: | Line 44: |
| == App Porting Hints == |
= Recommendations = 1. If you’re a beginner you probably want to use the Simple app type. see example02a, example03a 1. If you want to port as quickly as possible, again, go with the Simple app type. 1. If you want to publish an API you must use the Bundle app type 1. If you experience version conflicts or anticipate future version conflicts, again you must use the Bundle app type. 1. If you are in doubt, you should probably use the Simple app type. You can always port it to the Bundle app type later should that become necessary. Both styles are supported and will be until (at least) version 4.0. = App Porting Hints = |
| Line 53: | Line 59: |
| == Questions, suggestions == | = Questions, suggestions = |
Contents
About the cookbook
To help app developers to develop their own app, the Cytoscape developer team developed the cookbook, a collection of small apps. The cookbook could be used to
- get your feet wet
- find a template project to extend
- find out how to do something in Cytoscape.
How to use the cookbook?
SVN repository: http://chianti.ucsd.edu/svn/core3/support/trunk/samples/
Steps:
- Check out sample project from SVN repository with the above URL
- Compile with “mvn clean install”
- Copy the jar in the project target directory to Cytoscape installation: bundles/apps
- Start Cytoscape 3.0
The list of app examples in the cookbook
The list of sample apps is basically the same as in the cookbook for Cytoscape 2.X. They are mostly Cytoscape Bundle apps, but also include a few Simple apps. Some of them are,
How to add a tabbed Panel to Control panel?
How to add an image icon (menu item) to the toolbar?
How to create, modify, and destroy a network, nodes, and edges?
How to save/restore app states?
How to use the Cytoscape task monitor to show the progress of my job?
Trouble shooting
If you get compile error,
Check the version number of parent POM, the latest is at Cytoscape repository
If this is a dependency problem, check the version number of depended bundle at Cytoscape repository
Recommendations
- If you’re a beginner you probably want to use the Simple app type. see example02a, example03a
- If you want to port as quickly as possible, again, go with the Simple app type.
- If you want to publish an API you must use the Bundle app type
- If you experience version conflicts or anticipate future version conflicts, again you must use the Bundle app type.
- If you are in doubt, you should probably use the Simple app type. You can always port it to the Bundle app type later should that become necessary. Both styles are supported and will be until (at least) version 4.0.
App Porting Hints
How to
- get current network --- see sample app 5
- get attributes --- see sample app 11
- add a menu item --- see sample app 3
Questions, suggestions
Please send e-mail to cytoscape help desk or discussion group