Folder : sync_to_synapse
Folder_SyncToSynapse.RdUpload files to Synapse using a manifest CSV file.
Accepts manifests produced by synSyncFromSynapse(),
synDownloadListFiles(), or the Synapse UI download cart.
The manifest must have at minimum a path and parentId column.
All other columns that are not part of the standard manifest column set
are treated as file annotations.
Standard manifest columns: ID, name, parentId, contentType, path, synapseStore, activityName, activityDescription, forceVersion, used, executed
Usage
synSyncToSynapse(instance, manifest_path, dry_run=FALSE, send_messages=TRUE, retries=4L, merge_existing_annotations=TRUE, associate_activity_to_new_version=FALSE, synapse_client=NULL)Arguments
- instance
(Folder) The Folder instance to operate on.
- manifest_path
(character) Path to the CSV manifest file.
- dry_run
(logical) If TRUE, perform full validation of the manifest (including verifying that all parent containers exist in Synapse) but skip the actual file upload.
- send_messages
(logical) If TRUE, send a Synapse notification message on completion.
- retries
(integer) Number of notification retries (only relevant when send_messages=TRUE).
- merge_existing_annotations
(logical) If TRUE, merge manifest annotations with existing annotations on Synapse. If FALSE, overwrite them.
- associate_activity_to_new_version
(logical) If TRUE and a version update occurs, the existing Synapse activity is associated with the new version.
- synapse_client
(Optional[Synapse]) If not passed in, the last created instance from the Synapse class constructor will be used.