addObject: Manipulate Objects held by an Entity
In Sage-Bionetworks/rSynapseClientRewrite: Synapse R Client from Sage Bionetworks

Description Usage Arguments Details Value Author(s) See Also

Functions for manipulating R objects held by an entity.

addObject(owner, object, name, unlist)
deleteObject(owner, which)
getObject(owner, which)
renameObject(owner, which, name)

`owner`	The entity to be modified
`object`	The object to be added or renamed
`name`	optional argument specifying the to be given to the object. Defaults to the name of the object when passed as an argument.
`unlist`	boolean indicating whether list objects should be added as a single object (unlist = TRUE) or as one object for each named element (unlist=FALSE)
`which`	the name of the object to be deleted or returned.

It is important to note that the objects held by an entity are stored in an environment. In R environments are passed by reference. So, if you make multiple copies of an entity, any modifications made to the objects held by one copy of the entity will be propagated to all copies of that entity. use copyEntity to prevent this.

Another implication of using environments is that it is not technically necessary to catch the return value from these functions. However, it may help the clarity of your code to do so.

The modified owner (invisibly)

Matt Furia

addFile copyEntity

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