Diff for "Cytoscape_3/UserManual/Command_Line_Arguments"

Differences between revisions 9 and 14 (spanning 5 versions)

This is a legacy document

This page has been deprecated and is no longer updated. The current version of the Cytoscape manual can be found at http://manual.cytoscape.org/

Cytoscape recognizes a number of optional command line arguments, including run-time specification of network files, node and edge data files, and session files. This is the output generated when Cytoscape is executed with the "-h" or "--help" flag:

usage: cytoscape.{sh|bat} [OPTIONS]
 -h,--help             Print this message.
 -v,--version          Print the version number.
 -s,--session <file>   Load a cytoscape session (.cys) file.
 -N,--network <file>   Load a network file (any format).
 -P,--props <file>     Load cytoscape properties file (Java properties
                       format) or individual property: -P name=value.
 -V,--vizmap <file>    Load vizmap properties file (Cytoscape VizMap
                       format).
 -S,--script <file>    Execute commands from script file.
 -R,--rest <port>      Start a rest service.

Any file specified for an option may be specified as either a path or as a URL. For example you can specify a network as a file (assuming that myNet.sif exists in the current working directory): cytoscape.sh -N myNet.sif.

Note: if there are spaces in the file path, be sure to put quotes around it: cytoscape.bat -N "C:\Program Files\Cytoscape\sampleData\galFiltered.sif".

Or you can specify a network as a URL: cytoscape.sh -N http://example.com/myNet.sif.

Argument	Description
-h,--help	This flag generates the help output you see above and exits.
-v,--version	This flag prints the version number of Cytoscape and exits.
-s,--session <file>	This option specifies a session file to be loaded. Since only one session file can be loaded at a given time, this option may only specified once on a given command line. The option expects a `.cys` Cytoscape session file. It is customary, although not necessary, for session file names to contain the .cys extension.
-N,--network <file>	This option is used to load all types of network files. SIF, GML, and XGMML files can all be loaded using the -N option. You can specify as many networks as desired on a single command line.
-P,--props <file>	This option specifies Cytoscape properties. Properties can be specified either as a properties file (in Java's standard properties format), or as individual properties. To specify individual properties, you must specify the property name followed by the property value where the name and value are separated by the '=' sign. For example to specify the defaultSpeciesName: `cytoscape.sh -P defaultSpeciesName=Human`. If you would like to include spaces in your property, simply enclose the name and value in quotation marks: `cytoscape.sh -P "defaultSpeciesName=Homo Sapiens"`. The property option subsumes previous options -noCanonicalization, -species, and -bioDataServer. Now it would look like: `cytoscape.sh -P defaultSpeciesName=Human -P noCanonicalization=true -P bioDataServer=myServer`.
-V,--vizmap <file>	This option specifies a Style file.
-S,--script <file>	This option executes commands from a specifed Cytoscape script file.
-R,--rest <port>	This option starts a Cytoscape REST service on the specified port.

All options described above (except for starting a REST service) can be accessed from the menu once Cytoscape is running.

Cytoscape_3/UserManual/Command_Line_Arguments (last edited 2016-04-26 22:10:02 by server2)

-  ← Revision 9 as of 2014-01-27 22:47:50 →
  Size: 3140
  Editor: server2
  Comment:
+  ← Revision 14 as of 2016-04-26 22:10:02 →
  Size: 61
  Editor: server2
  Comment:
-Deletions are marked like this.
+Additions are marked like this.
 Line 1:
-Cytoscape recognizes a number of optional command line arguments, including run-time specification of network files, node and edge data files, and session files. This is the output generated when Cytoscape is executed with the "-h" or "--help" flag:



{{{

usage: cytoscape.{sh|bat} [OPTIONS]

 -h,--help             Print this message.

 -v,--version          Print the version number.

 -s,--session <file>   Load a cytoscape session (.cys) file.

 -N,--network <file>   Load a network file (any format).

 -P,--props <file>     Load cytoscape properties file (Java properties

                       format) or individual property: -P name=value.

 -V,--vizmap <file>    Load vizmap properties file (Cytoscape VizMap

                       format).

 -S,--script <file>    Execute commands from script file.

 -R,--rest <port>      Start a rest service.

}}}



Any file specified for an option may be specified as either a path or as a URL. For example you can specify a network as a file (assuming that myNet.sif exists in the current working directory): {{{cytoscape.sh -N myNet.sif}}}. Or you can specify a network as a URL: {{{cytoscape.sh -N http://example.com/myNet.sif}}}.

||'''Argument''' ||'''Description''' ||

||-h,--help ||This flag generates the help output you see above and exits. ||

||-v,--version ||This flag prints the version number of Cytoscape and exits. ||

||-s,--session <file> ||This option specifies a session file to be loaded.  Since only one session file can be loaded at a given time, this option may only specified once on a given command line.  The option expects a {{{.cys}}} Cytoscape session file.  It is customary, although not necessary, for session file names to contain the .cys extension. ||

||-N,--network <file> ||This option is used to load all types of network files.  SIF, GML, and XGMML files can all be loaded using the -N option.  You can specify as many networks as desired on a single command line. ||

||-P,--props <file> ||This option specifies Cytoscape properties.  Properties can be specified either as a properties file (in Java's standard properties format), or as individual properties. To specify individual properties, you must specify the property name followed by the property value where the name and value are separated by the '=' sign.  For example to specify the defaultSpeciesName:  {{{cytoscape.sh -P defaultSpeciesName=Human}}}.  If you would like to include spaces in your property, simply enclose the name and value in quotation marks:  {{{cytoscape.sh -P "defaultSpeciesName=Homo Sapiens"}}}.  The property option subsumes previous options -noCanonicalization, -species, and -bioDataServer.  Now it would look like: {{{cytoscape.sh -P defaultSpeciesName=Human -P noCanonicalization=true -P bioDataServer=myServer}}}. ||

||-V,--vizmap <file> ||This option specifies a Style file. ||

||-S,--script <file> ||This option executes commands from a specifed Cytoscape script file.||

||-R,--rest <port> ||This option starts a Cytoscape REST service on the specified port.||



All options described above can be loaded from the GUI once Cytoscape is running.
+#DEPRECATED

<<Include(Cytoscape_3/UserManual/Deprecated)>>