Retrieve an object from Synapse

Usage

synGet(id, version=NULL, downloadFile=T, downloadLocation=NULL, ifcollision="keep.both", load=F)

Arguments

id
The Synapse ID of the entity to retrieve.
version
Optional: The version number of the entity to retrieve. Defaults to the most recent version
downloadFile
For File entities only. If TRUE then the attached file is downloaded to the 'downloadLocation'
downloadLocation
For File entities only. The folder in the local file system to which the attached file is to be downloaded. If omitted, then a default location in a cache is used. See getFileLocation
ifcollision
if.collision is one of "keep.both", "keep.local", or "overwrite.local", telling the system what to do if a different file is found at the given local file location
load
If TRUE then deserialize the downloaded file into memory, using the R 'load' command (See getObject, listObjects)

Description

Retrieve an object from Synapse

Details

Get an entity (File, Folder, TableSchema, etc.) from the Synapse server, with its attributes (properties, annotations) and, optionally (for a File entity), with its associated file.