commandsPOST: Commands POST

View source: R/Commands.R

commandsPOSTR Documentation

Commands POST

Description

Using the same syntax as Cytoscape's Command Line Dialog, this function converts a command string into a CyREST query URL, executes a POST 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.

Usage

commandsPOST(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, named list, status or None.

Examples


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


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