commandsGET: Commands GET
In cytoscape/RCy3: Functions to Access and Control Cytoscape

commandsGET

R Documentation

Commands GET

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. The function check whether actual call is local or remote first. If remote, requests will go through Jupyter-Bridge. Extremely long commands may result in an immediate "URI Too Long" failure because 'commandsRun()' uses HTTP GET to call the CyREST API, and HTTP GET has known limitations. You can use 'commandsPost()' instead, though the return value will be different. 'commandsPost()' uses HTTP POST, which has no limitations.

Usage

commandsGET(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


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

cytoscape/RCy3 documentation built on Nov. 1, 2024, 2:49 a.m.