Query The Synapse API

Usage

synapseQuery(queryStatement) synQuery(queryStatement)

Arguments

queryStatement
The query statement
blockSize
Defaults to NULL. If blockSize is set to an integer, returns a QueryResult object.

Description

Provides an interface to the Synapse API

Details

See the Query service API wiki for details on how to form a query: http://sagebionetworks.jira.com/wiki/display/PLFM/Repository+Service+API#RepositoryServiceAPI-QueryAPI

Value

Depending on whether blockSize is specified, returns a data.frame holding all query results or a QueryResult object, which enables paging through query results in increments of blockSize rows.

Care should be taken to return a reasonable number of results. The service enforces a limit on the size of responses and will return an error if that limit is exceeded. Specifying only necessary columns, limiting the number of rows, and paging by specifying blockSize are all good strategies for staying within the response size limit.

See also

QueryResult

Author

Nicole Deflaux