Cytoscape Wiki|
Size: 2642
Comment:
|
Size: 3733
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| In this chapter, you will learn how to use Cytoscape from command line and scripts. | In this chapter, you will learn how to use Cytoscape from the command line and scripts. These features replace '''''Scripting''''' module in the past versions of Cytoscape. |
| Line 5: | Line 5: |
| ==== Topics ==== | == Topics == |
| Line 7: | Line 7: |
|
* Commands * RESTful API * Command REST API * cyREST |
* '''''Commands''''' * '''RESTful API''' * '''Command REST API''' * '''cyREST''' |
| Line 15: | Line 15: |
| Cytoscape has intuitive graphical user interface for interactive network data integration, analysis, and visualization. It is a great way for exploratory data analysis, but what happens if you have hundreds of data files or need to ask someone to execute your data analysis workflows? It is virtually impossible to apply same operations to hundreds of networks manually with GUI, and more importantly, although you can save your ''results'' as session files, you cannot save your '''''workflows''''' if your analysis is based on point-and-click GUI operation. Recording workflows is the key feature for reproducible data analysis, but it was a missing feature in past versions for Cytoscape. The latest version of Cytoscape has several options to script and automate your workflows. | Cytoscape has intuitive graphical user interface for ''interactive'' network data integration, analysis, and visualization. It is a great way for exploratory data analysis, but what happens if you have hundreds of data files or need to ask someone to execute your data analysis workflows? It is virtually impossible to apply same operations to hundreds of networks manually with GUI, and more importantly, although you can save your '''''results''''' as session files, you cannot save your '''''workflows''''' if you perform your data analysis with point-and-click GUI operations. To resolve this issue, recording workflows is the key feature for reproducible data analysis workflows, but it was a missing feature in past versions for Cytoscape. The latest version of Cytoscape has several options to script and automate your workflows. |
| Line 17: | Line 17: |
|
=== Options for Programmatic Access === |
== Options for Programmatic Access == |
| Line 21: | Line 20: |
| ==== Commands ==== | === Commands === |
| Line 26: | Line 25: |
| '''''Commands''''' is the built-in Cytoscape feature to automate your workflow as a simple script. You can learn more about this feature in this section: | '''''Commands''''' is the built-in Cytoscape feature to automate your workflow as simple script. You can learn more about this feature in this section: |
| Line 31: | Line 30: |
|
===== Sample Scripts ===== {{{ (TBD) }}} |
=== RESTful API === In some cases, you may need to use fully featured programming languages, such as Python, R, Ruby, or JavaScript to script your workflow. For such use cases, accessing Cytoscape via REST API is the right option. |
| Line 36: | Line 33: |
|
==== REST API for Commands ==== In addition to running Command scripts, Command module has REST API to access available commands. |
|
| Line 37: | Line 36: |
|
==== RESTful API ==== In some cases, you may need to use fully featured programming languages, such as Python, R, Ruby, or JavaScript, ===== Commands REST API ===== In addition to running scripts, Commands have REST API to access the By default, this feature is disables. To run REST server for Commands, please follow these steps: |
By default, this feature is disabled. To run REST API server for Commands, please follow these steps: |
| Line 47: | Line 40: |
| * Terminal or [[|iTerm]] (For Mac) | * Terminal or [[https://www.iterm2.com/|iTerm2]] (For Mac) |
| Line 67: | Line 60: |
| 1. If yo see list of available commands, you are ready to use Command API | 1. If you see list of available commands, you are ready to use Command API |
| Line 72: | Line 65: |
| ===== cyREST ===== | ==== cyREST ==== |
| Line 76: | Line 69: |
| '''[[http://apps.cytoscape.org/apps/cyrest|cyREST]] is a language-agnostic, programmer-friendly RESTful API module for Cytoscape'''. If you want to build your own workflow with [[http://www.r-project.org/|R]], [[https://www.python.org/|Python]] or other programming languages along with Cytoscape, this is the option for you. You can use popular tools, including IPython/Jupyter Notebook and RStudio as your orchestration tool for your data visualization workflow with Cytoscape. | |
| Line 77: | Line 71: |
| cyREST is available from | |
| Line 79: | Line 72: |
|
{{attachment:jupyter.png}} (Sample [[http://jupyter.org/|Jupyter Notebook]] written with cyREST and [[https://github.com/idekerlab/py2cytoscape|py2cytoscape]]) Currently, cyREST is available as an App for Cytoscape 3.2.1 and later. Please visit the link below for more information. * [[http://apps.cytoscape.org/apps/cyrest|cyREST App Store page]] ---- |
Programmatic Access to Cytoscape Features
In this chapter, you will learn how to use Cytoscape from the command line and scripts. These features replace Scripting module in the past versions of Cytoscape.
Topics
Commands
RESTful API
Command REST API
cyREST
Background
Cytoscape has intuitive graphical user interface for interactive network data integration, analysis, and visualization. It is a great way for exploratory data analysis, but what happens if you have hundreds of data files or need to ask someone to execute your data analysis workflows? It is virtually impossible to apply same operations to hundreds of networks manually with GUI, and more importantly, although you can save your results as session files, you cannot save your workflows if you perform your data analysis with point-and-click GUI operations. To resolve this issue, recording workflows is the key feature for reproducible data analysis workflows, but it was a missing feature in past versions for Cytoscape. The latest version of Cytoscape has several options to script and automate your workflows.
Options for Programmatic Access
There are two ways to access Cytoscape programmatically: Commands and RESTful API.
Commands
Commands is the built-in Cytoscape feature to automate your workflow as simple script. You can learn more about this feature in this section:
RESTful API
In some cases, you may need to use fully featured programming languages, such as Python, R, Ruby, or JavaScript to script your workflow. For such use cases, accessing Cytoscape via REST API is the right option.
REST API for Commands
In addition to running Command scripts, Command module has REST API to access available commands.
By default, this feature is disabled. To run REST API server for Commands, please follow these steps:
- Open a terminal session:
PowerShell (For windows)
Terminal or iTerm2 (For Mac)
- Terminal (For Linux)
- Start Cytoscape from command-line. You need to specify port number as a parameter (In this example, port 8888 will be opened for Command):
- For Mac/Linux
./cytoscape.sh -R 8888
For Windows./cytoscape.bat -R 8888
- For Mac/Linux
- Open the following URL with your web browser:
http://localhost:8888/cytoscape/commands
- If you see list of available commands, you are ready to use Command API
cyREST
cyREST is a language-agnostic, programmer-friendly RESTful API module for Cytoscape. If you want to build your own workflow with R, Python or other programming languages along with Cytoscape, this is the option for you. You can use popular tools, including IPython/Jupyter Notebook and RStudio as your orchestration tool for your data visualization workflow with Cytoscape.
(Sample Jupyter Notebook written with cyREST and py2cytoscape)
Currently, cyREST is available as an App for Cytoscape 3.2.1 and later. Please visit the link below for more information.
Debugging your workflows
(TBD)