synGetColumns: synGetColumns

In Sage-Bionetworks/synapser: R Language Bindings for Synapse API

synGetColumns

Description

Get the columns defined in Synapse either (1) corresponding to a set of column headers, (2) those for a given schema, or (3) those whose names start with a given prefix.

Usage

synGetColumns(x, limit=100, offset=0)

Arguments

x	a list of column headers, a Table Entity object (Schem/EntityViewSchema), a Table's Synapse ID, or a string prefix
limit	maximum number of columns to return (pagination parameter)
offset	the index of the first column to return (pagination parameter)

Value

a generator of Column objects. Use nextElem or as.list to access the values.

See Also

nextElem as.list

Examples

## Not run: 
columns<-as.list(synGetColumns("syn1234567", limit=100, offset=0))

## End(Not run)

Sage-Bionetworks/synapser documentation built on Aug. 23, 2024, 11:07 a.m.