...
| Command | R Syntax | Python Syntax | Command Line Syntax | |
|---|---|---|---|---|
| 1 – Basic Level | ||||
| Get an entity (file, folder, etc.) its attributes (properties, annotations) and, optionally, its associated file(s). | synGet(id, version, downloadFile=T, load=T) | synapse.get(id, version, downloadFile=True, load=True) | synapse get ID -v NUMBER | |
| synGet(entity, downloadFile=T, load=T)Create a Synapse file handle in memory, specifying the path to the file in the local file system, the name in Synapse, and the Folder in Synapse. This step 'stages' a file to be sent to Synapse. | File(path="/path/to/file", name="foo", parentId="syn101") | |||
| Create a Synapse file handle in memory which will be a serialized version of an in-memory object. | File(obj=<obj ref>, name="foo", parentId="syn101") | |||
| TODO: File which is a URL, not be uploaded to Synapse, just linked. | ||||
| Create or update an entity (file, folder, etc.) in Synapse. May also specify (1) whether a name collision in an attempted 'create' should become an 'update' and (2) whether to 'force' a new version to be created. | synStore(entity, createOrUpdate=T, forceVersion=T) | |||
| Get an entity (file, folder, etc.) from the Synapse server, with its attributes (properties, annotations) and, optionally, with its associated file(s). | synGet(id, version, downloadFile=T, load=T) | synapse.get(id, version, downloadFile=True, load=True) | synapse get ID -v NUMBER | |
| synGet(entity, downloadFile=T, load=T) | ||||
| 2 – Power User Level | ||||
| 3 – Web API Level | ||||
...