Differences between revisions 9 and 11 (spanning 2 versions)
Revision 9 as of 2015-06-22 20:16:20
Size: 3126
Editor: KeiichiroOno
Comment:
Revision 11 as of 2015-06-22 20:49:31
Size: 3733
Editor: KeiichiroOno
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. These features replace ''Scripting'' module in the past versions of Cytoscape. 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 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 32: Line 31:
In some cases, you may need to use fully featured programming languages, such as Python, R, Ruby, or JavaScript, 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 35: Line 34:
In addition to running Command scripts, Command module has REST API to access those   In addition to running Command scripts, Command module has REST API to access available commands.
Line 37: Line 36:
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 61: 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 70: 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.

Currently, cyREST is available from [[App Store|http://apps.cytoscape.org/apps/cyrest]].
'''[[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 75: Line 72:
 {{attachment:jupyter.png}}
(Sample [[http://jupyter.org/|Jupyter Notebook]] written with cyREST and [[https://github.com/idekerlab/py2cytoscape|py2cytoscape]])
Line 76: Line 75:

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

  • CommandTool.png

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:

  1. Open a terminal session:
  2. 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
  3. Open the following URL with your web browser:
    • http://localhost:8888/cytoscape/commands
  4. If you see list of available commands, you are ready to use Command API
    • CommandAPI.png

cyREST

https://raw.githubusercontent.com/idekerlab/cyREST/master/docs/images/logo300.png

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.

  • jupyter.png

(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)

Cytoscape_3/UserManual/ProgrammaticAccess (last edited 2016-04-26 22:22:57 by server2)

Funding for Cytoscape is provided by a federal grant from the U.S. National Institute of General Medical Sciences (NIGMS) of the Na tional Institutes of Health (NIH) under award number GM070743-01. Corporate funding is provided through a contract from Unilever PLC.

MoinMoin Appliance - Powered by TurnKey Linux