synGetChildren: synGetChildren

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

synGetChildren

Description

Retrieves all of the entities stored within a parent such as folder or project.

Usage

synGetChildren(parent, includeTypes=list("folder", "file", "table", "link", "entityview", "dockerrepo"), sortBy = 'NAME', sortDirection = 'ASC')

Arguments

parent	An id or an object of a Synapse container or NULL to retrieve all projects
includeTypes	Must be a list of entity types (ie. list("folder","file") which can be found here: http://docs.synapse.org/rest/org/sagebionetworks/repo/model/EntityType.html
sortBy	How results should be sorted. Can be 'NAME', or 'CREATED_ON'.
sortDirection	The direction of the result sort. Can be 'ASC', or 'DESC'

Value

An iterator that shows all the children of the container. Use nextElem or as.list to access the values.

See Also

nextElem as.list

Examples

## Not run: 
iterator <- synGetChildren("syn123456", includeTypes = list("file"), sortBy = "CREATED_ON")

## End(Not run)

Sage-Bionetworks/synapseclient documentation built on Feb. 9, 2024, 4:26 p.m.