Folder: Synapse Folder Constructor

In Sage-Bionetworks/rSynapseClient: Synapse R Client from Sage Bionetworks

Description

Constructor for Folder

Usage

Folder(name, parentId, ...)

Arguments

name	Name of the Folder to be created in Synapse
parentId	The Synapse ID of the parent Project or Folder in which to create the Folder (e.g. "syn101")
...	Additional named parameters are interpreted as properties or annotations on the Folder

Value

The created Folder is returned. NOTE: This is an in-memory representation. To persist to Synapse use synStore().

Slots

attachOwn

internally used information to handle file caching

annotations

annotations set on the object

synapseEntityKind

in this case, 'Folder'

synapseWebUrl

Synapse web URL

generatedBy

the Activity which generated this Folder, if applicable (see Activity)

properties

Synapse properties for a Folder. Properties of interest include:

id

unique Synapse ID as set by the system upon synStore (not set by user)

name

user supplied name

description

user supplied description

Author(s)

Bruce Hoff

See Also

File Project synGet synStore

Sage-Bionetworks/rSynapseClient documentation built on May 9, 2019, 7:04 p.m.