synGetTable: Get a table on Synapse

In philerooski/synhelper: What the Package Does (One Line, Title Case)

Description

Downloads a table on Synapse. Either as a dataframe, a query object, or returns the query string by itself.

Usage

synGetTable(
  synapse_id,
  columns = list(),
  conditionals = list(),
  limit = NULL,
  offset = NULL,
  as_query_str = FALSE,
  as_data_frame = TRUE
)

Arguments

synapse_id	The Synapse ID of the table.
columns	A character vector of columns to download. Defaults to all columns.
conditionals	A character vector of SQL conditionals.
limit	Upper limit on the number of rows returned.
offset	Number of rows to offset in the SQL query.
as_query_str	If TRUE, returns the query string without executing the query. Defaults to FALSE.
as_data_frame	If TRUE, returns the table as a dataframe. Defaults to TRUE.

philerooski/synhelper documentation built on Oct. 11, 2020, 4:40 p.m.