...
Creates or updates metadata in Synapse, including code version.
returns
nothing
...
downloadEntity(codeId, localPath)
parameters
codeId: id of metadata object in Synapse
localPath: directory on machine which is running the R session
side effects
Checks that Version in Code object matches repository, and revises the Code object if not.
Checks that local files are in sync with repository and, if not, prints the svn command needed to sync. [Alt: Could do svn 'checkout' or 'update' on user's behalf.]
returns
Code object
loadEntity(codeObj)
parameters
codeObj
side effects
If (codeId!=null)
- Checks that Version in Code object is up-to-date with repository, and revises the Code object if not.
- Checks that local files are in sync with repository, and throws exception if not (printing the svn command needed to sync). [Alt: Could do svn 'checkout' or 'update' on user's behalf.]
- Get current Step.
...
- Adds codeId, revision into Step.
'sources' code into memory
returns
Code object(i.e. if 'codeObj' is just a local variable, this is a utility to source a collection of files.)
returns
nothing
deleteEntity(codeId)
parameters
codeId: ID of the object in Synapse
side effects
Delete metadata from Synapse.
Print out delete command that user should execute.[Alt: Delete from the code repository.]
returns
Nothing.
TODO: What if not all steps are successful?
TODO: Should we delete from the local disk? From the R session?
...