Learn R Programming

synapseClient (version 1.14-0)

synDownloadTableFile: synDownloadTableFile

Description

Download a file associated with a cell in a Table

Usage

synDownloadTableFile(table, rowIdAndVersion, columnName, downloadLocation=NULL, ifcollision="keep.both")

Arguments

table
a Table object or its Synapse Id
rowIdAndVersion
the row ID and version in the form "r_v", as found in the row labels of a query result returned as a data frame
columnName
the column name, as found in the column labels of a query result returned as a data frame
downloadLocation
the folder into which the file should be downloaded. If NULL then a default location will be used
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

Value

The path of the downloaded file.

Details

When downloading, file caching is used: If the file has already been downloaded (and not modified and/or ifcollision is set to "keep.local") then the file will not be downloaded a second time.

See Also

synTableQuery