commandsRun: Run a Command

In cytoscape/RCy3: Functions to Access and Control Cytoscape

Run a Command

Description

Using the same syntax as Cytoscape's Command Line Dialog, this function converts a command string into a CyREST query URL, executes a GET request, and parses the result content into an R list object. Same as commandsGET.

Usage

commandsRun(cmd.string, base.url = .defaultBaseUrl)

Arguments

cmd.string	(char) command
base.url	(optional) Ignore unless you need to specify a custom domain, port or version to connect to the CyREST API. Default is http://localhost:1234 and the latest version of the CyREST API supported by this version of RCy3.

Value

A list, status or None.

Examples

commandsRun('layout get preferred')
commandsRun('network list properties')
commandsRun('layout force-directed defaultNodeMass=1')

cytoscape/RCy3 documentation built on April 7, 2024, 2:17 p.m.