Need documentation in the vignettes about how to programmatically add versionComment

Description

Need to add documentation in the vignettes about how to programmatically add versionComments when uploading a new version.

  1. Upload a new version of raw_data.txt, EXPLICIT UPDATE EXAMPLE
    library(synapser)

  1. fetch the file in Synapse, where "syn2222" is the synID of the file in Synapse
    file_to_update <- synGet('syn2222', downloadFile=FALSE)

  1. save the local path to the new version of the file
    file_to_update$properties$path <- '/path/to/new/version/of/raw_data.txt'

  1. add a version comment
    file_to_update$properties$versionComment <- 'Some sort of comment about the new version of the file.'

  1. store the new file
    updated_file <- synStore(file_to_update)

  1. Upload a new version of raw_data.txt, IMPLICIT UPDATE EXAMPLE

  2. Assuming that there is a file created with:
    synStore(File('path/to/old/raw_data.txt', parentId='syn123456'))

  1. To create a new version of that file, make sure you store it with the exact same name
    new_file <- synStore(File('path/to/new_version/raw_data.txt', parentId='syn123456'))

Environment

None

Status

Assignee

Unassigned

Reporter

Yooree Chae

Labels

None

Validator

Kenneth Daily

Release Version History

None

Priority

Major
Configure