synTableQuery: synTableQuery

In Sage-Bionetworks/rSynapseClient: Synapse R Client from Sage Bionetworks

Description

Query a Synapse Table

Usage

synTableQuery(sqlString, loadResult=TRUE, verbose=TRUE, filePath=NULL)

Arguments

sqlString	The query to execute. For complete syntax description see: rest.synapse.org/POST/table/query/async/start.html.
loadResult	If true then return the query result, else return the path of a csv file containing the result.
verbose	If TRUE then print progress information while results are retrieved.
filePath	File path to which the csv file version of the query is stored. If omitted the result will be written in the default file cache location.

Value

If loadResult is TRUE then the result is a Table object with a 'values' slot holding the query results as a data frame. If loadResult is FALSE then the result is a Table object with a 'filePath' slot holding the path to a csv-formatted file of results.

See Also

Table

Sage-Bionetworks/rSynapseClient documentation built on May 9, 2019, 7:04 p.m.