sandboxRemoveFile: sandboxRemoveFile

In cytoscape/RCy3: Functions to Access and Control Cytoscape

sandboxRemoveFile

Description

Remove a file from a sandbox. The named file is removed from the named sandbox. If the sandbox is the entire file system (i.e., for standalone R execution), the file name can be an absolute path. Otherwise, it is a path relative to the named sandbox. Note that there is no function that deletes a directory, except for sandboxRemove(), which deletes a sandbox and all of its contents.

Usage

sandboxRemoveFile(fileName, sandboxName = NULL, base.url = .defaultBaseUrl)

Arguments

fileName	Name of file to delete (as absolute path or sandbox-relative path)
sandboxName	Name of sandbox containing file. None means "the current sandbox".
base.url	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 RCy3.

Value

dict: 'filePath': <file's absolute path in Cytoscape workstation>, 'existed': True if file existed before being deleted

Examples

sandboxRemoveFile()

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