py4cytoscape.commands.command_run_file

command_run_file(file, args=None, base_url='http://127.0.0.1:1234/v1')[source]

Command Run File.

The run command will execute a command script from the file pointed to by the file argument, which should contain Cytoscape commands, one per line. Arguments to the script are provided by the args argument

Parameters

file (str) – Path to the file containing Cytoscape commands, one per line.
args (list or None) – Provide arguments to the script. Default is None.
base_url (str) – Ignore unless you need to specify a custom domain, port or version to connect to the CyREST API. Default is http://127.0.0.1:1234 and the latest version of the CyREST API supported by this version of py4cytoscape.

Returns

{}

Return type

dict

Raises

requests.exceptions.RequestException – if can’t connect to Cytoscape or Cytoscape returns an error

Examples

>>> command_run_file('data/CommandScript.txt')
{}