Learn R Programming

synapseClient (version 1.14-0)

synDownloadTableColumns: synDownloadTableColumns

Description

Download files referenced in a Table

Usage

synDownloadTableColumns(synTable, tableColumns)

Arguments

synTable
The tabular data containing file references to download. Must be a TableDataFrame object returned from synTableQuery
tableColumns
A character object listing the column(s) to be retrieved.

Value

Returns a list whose names are the fileHandle IDs found in the specified columns of the given Table and each value of which is the path to the requested file or NULL if the file was not able to be downloaded.

Details

Downloads the files corresponding to the references in the selected rows of the given Table, while avoiding re-downloading those files which are already downloaded to the default download location.

See Also

synTableQuery