Creates a new Entity or updates an existing Entity, uploading any files in the process.

synStore(obj, used=NULL, executed=NULL, activity=NULL, activityName=NULL, activityDescription=NULL, createOrUpdate=NULL, forceVersion=NULL, versionLabel=NULL, isRestricted=NULL)

Arguments

obj

A Synapse Entity, Evaluation, or Wiki

used

optional named parameter: The Entity, Synapse ID, or URL
used to create the object (can also be a list of these)

executed

optional named parameter: The Entity, Synapse ID, or URL representing code executed
to create the object (can also be a list of these)

activity

optional named parameter: Activity object specifying the user's provenance

activityName

optional named parameter: Activity name to be used in conjunction with *used* and *executed*.

activityDescription

optional named parameter: Activity description to be used in conjunction with *used* and *executed*.

createOrUpdate

optional named parameter: Indicates whether the method should automatically perform an update if the 'obj'
conflicts with an existing Synapse object. Defaults to TRUE.

forceVersion

optional named parameter: Indicates whether the method should increment the version of the object even if
nothing has changed. Defaults to TRUE.

versionLabel

optional named parameter: Arbitrary string used to label the version.

isRestricted

optional named parameter: If set to true, an email will be sent to the Synapse access control team
to start the process of adding terms-of-use
or review board approval for this entity.
You will be contacted with regards to the specific data being restricted
and the requirements of access.

Details

Value

A Synapse Entity, Evaluation, or Wiki

References

Note

See also

Examples

# NOT RUN {
# Create a new project
project <- Project('My uniquely named project')
project <- synStore(project)

# Adding files with provenance:
#
# A synapse entity *syn1906480* contains data
# entity *syn1917825* contains code
#
activity <- Activity(
    'Fancy Processing',
    description='No seriously, really fancy processing',
    used=c('syn1906480', 'http://data_r_us.com/fancy/data.txt'),
    executed='syn1917825')
file <- File('/path/to/data/file.xyz', description='Fancy new data', parent=project)
file <- synStore(file, activity=activity)

# Evaluation
eval <- Evaluation(
  name = sprintf("My unique evaluation created on %s", format(Sys.time(), "%a %b %d %H%M%OS4 %Y")),
  description = "testing",
  contentSource = project$properties$id,
  submissionReceiptMessage = "Thank you for your submission!",
  submissionInstructionsMessage = "This evaluation only accepts files.")
eval <- synStore(eval)

# Wiki
content <- "
# My Wiki Page

Here is a description of my **fantastic** project!
"

wiki <- Wiki(owner = project,
             title = "My Wiki Page",
             markdown = content)
wiki <- synStore(wiki)
# }