Differences between revisions 5 and 8 (spanning 3 versions)
Revision 5 as of 2015-06-22 18:49:44
Size: 2036
Editor: KeiichiroOno
Comment:
Revision 8 as of 2015-06-22 19:55:12
Size: 2642
Editor: KeiichiroOno
Comment:
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
In this section, you will learn how to use programmatic access features for advanced Cytoscape users.
In this chapter, you will learn how to use Cytoscape from command line and scripts.
Line 13: Line 14:
=== Background ===
Cytoscape has intuitive graphical user interface for interactive network data integration, analysis, and visualization. It is a great way to exploratory analyze your data sets, but what happens if you have hundreds of data files? It is virtually impossible to apply same operations to hundreds of networks manually with GUI.

M
ore 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. Latest version of Cytoscape has several options to script and automate your workflows.
== 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 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.
Line 19: Line 18:
=== Options === === Options for Programmatic Access ===
Line 23: Line 22:
'''''Commands''''' is the built-in Cytoscape feature to automate your workflow as a simple script.
 {{attachment:CommandTool.png}}


'''''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:

 * [[Command_Tool|Command Tool]]
Line 44: Line 49:
 1. Start Cytoscape from command-line:  1. Start Cytoscape from command-line. You need to specify port number as a parameter (In this example, port 8888 will be opened for Command):
Line 48: Line 53:
./cytoscape.sh ./cytoscape.sh -R 8888
Line 53: Line 58:
./cytoscape.bat ./cytoscape.bat -R 8888
Line 56: Line 61:
 1.  1. Open the following URL with your web browser:
Line 58: Line 63:
{{{
}}}
    {{{
http://localhost:8888/cytoscape/commands
    }}}
Line 61: Line 67:
(TBD)  1. If yo see list of available commands, you are ready to use Command API

  {{attachment:CommandAPI.png}}
Line 65: Line 73:

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

Programmatic Access to Cytoscape Features

In this chapter, you will learn how to use Cytoscape from command line and scripts.

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 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.

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 a simple script. You can learn more about this feature in this section:

Sample Scripts

(TBD)

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:

  1. Open a terminal session:
    • PowerShell (For windows)

    • Terminal or [[|iTerm]] (For Mac)
    • Terminal (For Linux)
  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 yo 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 available from

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