14. 命令面板

命令面板 (Command Panel) 提供了一个通过 Commands API 对 Cytoscape 进行操作的简单命令行界面。它允许用户在 Cytoscape 中输入命令,并在 回复日志 (Reply Log) 中查看结果。

任何注册了命令的应用程序都将通过 命令面板 提供支持。命令是更通用的 Cytoscape 自动化 (Cytoscape Automation) 功能的一部分,该功能包含了多种编写 Cytoscape 执行脚本的方法。

可以通过 视图 (View) → 显示命令面板 (Show Command Panel) 打开 命令面板

命令面板 也可用于读取和执行脚本文件。脚本文件中的每一行都是发送给应用程序的命令。脚本文件可以通过在 Cytoscape 命令行中使用 -S 标志,或者通过 工具 (Tools) → 执行命令文件 (Execute Command File) 菜单项来输入。

Cytoscape 命令由三部分组成:命令类(或命名空间)、该命名空间内的命令,以及以一系列 名称=值 (name=value) 对形式提供的参数或选项。例如,要从 命令行对话框 (Command Line Dialog) 或命令脚本中导入 XGMML 格式文件,您可以使用

network import file filePath="path-to-file"

其中 network 是命名空间,import file 是命令,且只有一个参数:filePath=”文件路径”。如果有更多参数,它们将出现在同一行并以空格分隔。

命令面板 还使用 Command API 来提供帮助信息。单独输入 help 将列出所有的命令类(或命名空间),help 后跟命名空间将列出该命名空间支持的所有命令。如需查看特定命令的详细信息,可以在 help 后输入命名空间和命令(例如 help layout force-directed)。命令面板 会注册 command 命名空间,并支持单个命令:run,它接受一个文件参数。以下是来自 command 命名空间的 run 命令的帮助信息

help command run
       command run file=<File> 

同样,上述 network import file 示例的帮助信息为

help network import file
 network import file arguments:
 dataTypeList=<String>: List of column data types ordered by column index 
   (e.g. "string,int,long,double,boolean,intlist" or just "s,i,l,d,b,il")
 defaultInteraction=<String>: Default interaction type
 delimiters=<ListMultipleSelection [,,;, ,\t]>: Text Delimiters
 delimitersForDataList=<ListSingleSelection (\||\|/|,)>: 
   Text Delimiters for data list type
 file=<File>: Data Table file
 firstRowAsColumnNames=true|false: First row used for column names
 indexColumnSourceInteraction=<int>: Column for source interaction
 indexColumnTargetInteraction=<int>: Column for target interaction
 indexColumnTypeInteraction=<int>: Column for interaction type
 NetworkViewRendererList=<ListSingleSelection ()>: Network View Renderer
 RootNetworkList=<ListSingleSelection (-- Create new network collection 
   --|Network)>: Network Collection
 startLoadRow=<int>: Start Load Row
 TargetColumnList=<ListSingleSelection ()>: Node Identifier Mapping Column