as.list: as.list

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

as.list

Description

Gets all the values from an iterator

Usage

as.list(iterator)

Arguments

iterator

The iterator whose next value is to be retrieved.

Details

Certain functions return iterators rather than returning a list of all values. This is because the list may be large and/or expensive to generate in its entirety. The as.list function generates all the values from the iterator and returns them as a list. It is the responsibility of the caller to determine that the list is not too big to fit in memory or too expensive to generate in its entirety. The related function nextElem retrieves just one element of the iterator at a time and therefore is safer.

Value

A list of values returned by the iterator.

See Also

synGetChildren synChunkedQuery synGetEvaluationByContentSource synGetTeamMembers synGetSubmissions synGetSubmissionBundles synGetColumns synGetTableColumns nextElem

Examples

## Not run: 
iterator<-synGetTeamMembers(3324324)
members<-as.list(iterator)

## End(Not run)

Sage-Bionetworks/synapser documentation built on Feb. 7, 2024, 12:26 p.m.