sandboxGetFileInfo {RCy3} | R Documentation

## sandboxGetFileInfo

### Description

Get metadata on file in sandbox (or entire sandbox). If the current sandbox is the entire file system on a Cytoscape workstation, trying to delete it is an error. Otherwise, deleting the current sandbox results in the default sandbox becoming the new current sandbox. When running standalone on the same workstation as Cytoscape, the default sandbox is the entire file system on the Cytoscape workstation. When running in a Notebook or remote server, the default sandbox is the 'default_sandbox' created automatically under the under the filetransfer directory in the CytoscapeConfiguration directory. If that sandbox is deleted, it will be re-created so that subsequent file operations can complete successfully. Note that this function can be used to query either a file or a directory.

### Usage

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

### Arguments

`fileName` | Name of file whose metadata to return ... can be sandbox-relative path ... “.“ returns metadata on sandbox itself
`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': <full path on Cytoscape workstation>, 'modifiedTime': <last changed time, ” if file doesn't exist>, 'isFile': <True if file, False if directory>

### Examples

    sandboxGetFileInfo()

[Package RCy3 version 2.14.2 Index]