diff --git a/docs/articles/synapser.html b/docs/articles/synapser.html index b8d84057..a6cbd0b9 100644 --- a/docs/articles/synapser.html +++ b/docs/articles/synapser.html @@ -218,7 +218,7 @@

Accessing DataView the entity’s metadata in the R console:

 print(fileEntity)
-## File(name='filec7f2483a1da5', isLatestVersion=True, concreteType='org.sagebionetworks.repo.model.FileEntity', cacheDir='/var/folders/zl/j6z0kpys2gl7pwc1x63w0gwr001lqt/T/Rtmp1fbwe6', modifiedOn='2023-09-10T05:47:56.465Z', versionLabel='1', path='/var/folders/zl/j6z0kpys2gl7pwc1x63w0gwr001lqt/T/Rtmp1fbwe6/filec7f2483a1da5', _file_handle={'id': '128471083', 'etag': '3c5bfff5-bca6-45f0-ab2e-aacad4b7c2d8', 'createdBy': '3324230', 'createdOn': '2023-09-10T05:47:56.000Z', 'modifiedOn': '2023-09-10T05:47:56.000Z', 'concreteType': 'org.sagebionetworks.repo.model.file.S3FileHandle', 'contentType': 'application/octet-stream', 'contentMd5': '8465d33d9f407ef250ce519e92f300fb', 'fileName': 'filec7f2483a1da5', 'storageLocationId': 1, 'contentSize': 23, 'status': 'AVAILABLE', 'bucketName': 'proddata.sagebase.org', 'key': '3324230/f732db23-673e-4cd2-93fd-09561c8c485b/filec7f2483a1da5', 'isPreview': False, 'externalURL': None}, versionNumber=1, dataFileHandleId='128471083', createdOn='2023-09-10T05:47:56.272Z', id='syn52417540', modifiedBy='3324230', files=['filec7f2483a1da5'], etag='7750a89c-7606-4bcb-8e47-6c99da678425', createdBy='3324230', synapseStore=True, parentId='syn52417539')
+## File(createdOn='2023-09-10T05:57:33.808Z', files=['filed50b25528b1'], modifiedBy='3324230', dataFileHandleId='128471129', etag='705f7ba2-ca7b-4028-bd37-056fbbeb0924', concreteType='org.sagebionetworks.repo.model.FileEntity', _file_handle={'id': '128471129', 'etag': '2e832a48-e232-41c2-8d53-37627e08be9a', 'createdBy': '3324230', 'createdOn': '2023-09-10T05:57:34.000Z', 'modifiedOn': '2023-09-10T05:57:34.000Z', 'concreteType': 'org.sagebionetworks.repo.model.file.S3FileHandle', 'contentType': 'application/octet-stream', 'contentMd5': '8465d33d9f407ef250ce519e92f300fb', 'fileName': 'filed50b25528b1', 'storageLocationId': 1, 'contentSize': 23, 'status': 'AVAILABLE', 'bucketName': 'proddata.sagebase.org', 'key': '3324230/e53a6758-78e2-426f-b531-bd85871086c2/filed50b25528b1', 'isPreview': False, 'externalURL': None}, modifiedOn='2023-09-10T05:57:34.009Z', isLatestVersion=True, path='/var/folders/zl/j6z0kpys2gl7pwc1x63w0gwr001lqt/T/RtmpoNRYtU/filed50b25528b1', synapseStore=True, name='filed50b25528b1', cacheDir='/var/folders/zl/j6z0kpys2gl7pwc1x63w0gwr001lqt/T/RtmpoNRYtU', id='syn52417559', createdBy='3324230', versionLabel='1', parentId='syn52417558', versionNumber=1)

This is one simple way to read in a small matrix (we load just the first few rows):

@@ -286,7 +286,7 @@ 

Organizing Data in a Project## [1] "Data" ## ## [[1]]$id -## [1] "syn52417541" +## [1] "syn52417560" ## ## [[1]]$type ## [1] "org.sagebionetworks.repo.model.Folder" @@ -301,13 +301,13 @@

Organizing Data in a Project## [1] TRUE ## ## [[1]]$benefactorId -## [1] 52417539 +## [1] 52417558 ## ## [[1]]$createdOn -## [1] "2023-09-10T05:47:57.793Z" +## [1] "2023-09-10T05:57:35.816Z" ## ## [[1]]$modifiedOn -## [1] "2023-09-10T05:47:57.958Z" +## [1] "2023-09-10T05:57:36.006Z" ## ## [[1]]$createdBy ## [1] "3324230" @@ -318,10 +318,10 @@

Organizing Data in a Project## ## [[2]] ## [[2]]$name -## [1] "filec7f2483a1da5" +## [1] "filed50b25528b1" ## ## [[2]]$id -## [1] "syn52417540" +## [1] "syn52417559" ## ## [[2]]$type ## [1] "org.sagebionetworks.repo.model.FileEntity" @@ -336,13 +336,13 @@

Organizing Data in a Project## [1] TRUE ## ## [[2]]$benefactorId -## [1] 52417539 +## [1] 52417558 ## ## [[2]]$createdOn -## [1] "2023-09-10T05:47:56.272Z" +## [1] "2023-09-10T05:57:33.808Z" ## ## [[2]]$modifiedOn -## [1] "2023-09-10T05:47:56.465Z" +## [1] "2023-09-10T05:57:34.009Z" ## ## [[2]]$createdBy ## [1] "3324230" @@ -358,7 +358,7 @@

Organizing Data in a Project## [1] "Data" ## ## [[1]]$id -## [1] "syn52417541" +## [1] "syn52417560" ## ## [[1]]$type ## [1] "org.sagebionetworks.repo.model.Folder" @@ -373,13 +373,13 @@

Organizing Data in a Project## [1] TRUE ## ## [[1]]$benefactorId -## [1] 52417539 +## [1] 52417558 ## ## [[1]]$createdOn -## [1] "2023-09-10T05:47:57.793Z" +## [1] "2023-09-10T05:57:35.816Z" ## ## [[1]]$modifiedOn -## [1] "2023-09-10T05:47:57.958Z" +## [1] "2023-09-10T05:57:36.006Z" ## ## [[1]]$createdBy ## [1] "3324230" @@ -390,10 +390,10 @@

Organizing Data in a Project## ## [[2]] ## [[2]]$name -## [1] "filec7f2483a1da5" +## [1] "filed50b25528b1" ## ## [[2]]$id -## [1] "syn52417540" +## [1] "syn52417559" ## ## [[2]]$type ## [1] "org.sagebionetworks.repo.model.FileEntity" @@ -408,13 +408,13 @@

Organizing Data in a Project## [1] TRUE ## ## [[2]]$benefactorId -## [1] 52417539 +## [1] 52417558 ## ## [[2]]$createdOn -## [1] "2023-09-10T05:47:56.272Z" +## [1] "2023-09-10T05:57:33.808Z" ## ## [[2]]$modifiedOn -## [1] "2023-09-10T05:47:56.465Z" +## [1] "2023-09-10T05:57:34.009Z" ## ## [[2]]$createdBy ## [1] "3324230" @@ -437,7 +437,7 @@

Organizing Data in a Project## [1] "Data" ## ## $id -## [1] "syn52417541" +## [1] "syn52417560" ## ## $type ## [1] "org.sagebionetworks.repo.model.Folder" @@ -452,13 +452,13 @@

Organizing Data in a Project## [1] TRUE ## ## $benefactorId -## [1] 52417539 +## [1] 52417558 ## ## $createdOn -## [1] "2023-09-10T05:47:57.793Z" +## [1] "2023-09-10T05:57:35.816Z" ## ## $modifiedOn -## [1] "2023-09-10T05:47:57.958Z" +## [1] "2023-09-10T05:57:36.006Z" ## ## $createdBy ## [1] "3324230" @@ -467,10 +467,10 @@

Organizing Data in a Project## [1] "3324230" ## ## $name -## [1] "filec7f2483a1da5" +## [1] "filed50b25528b1" ## ## $id -## [1] "syn52417540" +## [1] "syn52417559" ## ## $type ## [1] "org.sagebionetworks.repo.model.FileEntity" @@ -485,13 +485,13 @@

Organizing Data in a Project## [1] TRUE ## ## $benefactorId -## [1] 52417539 +## [1] 52417558 ## ## $createdOn -## [1] "2023-09-10T05:47:56.272Z" +## [1] "2023-09-10T05:57:33.808Z" ## ## $modifiedOn -## [1] "2023-09-10T05:47:56.465Z" +## [1] "2023-09-10T05:57:34.009Z" ## ## $createdBy ## [1] "3324230" @@ -524,7 +524,7 @@

Organizing Data in a Project= TRUE ) ## Retrieving a deleted folder causes: Error in value[[3L]](cond): 404 Client Error: -## Entity syn52417541 is in trash can.

+## Entity syn52417560 is in trash can.

In addition to simple data storage, Synapse entities can be annotated with key/value metadata, described in markdown documents (wikis), and linked together in provenance graphs to create a reproducible record of @@ -711,12 +711,12 @@

Evaluationseval <- synGetEvaluation(eval$id) eval ## { -## "contentSource": "syn52417544", -## "createdOn": "2023-09-10T05:48:12.566Z", +## "contentSource": "syn52417563", +## "createdOn": "2023-09-10T05:57:50.610Z", ## "description": "testing", -## "etag": "1da8272d-5b79-4e7b-930d-457d33e5bc25", -## "id": "9615411", -## "name": "My unique evaluation created on Sat Sep 09 224812.3255 2023", +## "etag": "713fbeac-66a5-4cb4-a82b-e8429255ac60", +## "id": "9615412", +## "name": "My unique evaluation created on Sat Sep 09 225750.3941 2023", ## "ownerId": "3324230", ## "submissionInstructionsMessage": "This evaluation only accepts files.", ## "submissionReceiptMessage": "Thank you for your submission!" @@ -741,26 +741,26 @@

Evaluations## { ## "contributors": [ ## { -## "createdOn": "2023-09-10T05:48:15.051Z", +## "createdOn": "2023-09-10T05:57:52.987Z", ## "principalId": "3324230" ## } ## ], -## "createdOn": "2023-09-10T05:48:15.051Z", -## "entityBundleJSON": "{\"entity\":{\"name\":\"filec7f27aac4a73\",\"id\":\"syn52417545\",\"etag\":\"71bc491e-27d6-46be-b8be-9fbe54d58147\",\"createdOn\":\"2023-09-10T05:48:14.427Z\",\"modifiedOn\":\"2023-09-10T05:48:14.608Z\",\"createdBy\":\"3324230\",\"modifiedBy\":\"3324230\",\"parentId\":\"syn52417544\",\"concreteType\":\"org.sagebionetworks.repo.model.FileEntity\",\"versionNumber\":1,\"versionLabel\":\"1\",\"isLatestVersion\":true,\"dataFileHandleId\":\"128471088\"},\"entityType\":\"file\",\"annotations\":{\"id\":\"syn52417545\",\"etag\":\"00000000-0000-0000-0000-000000000000\",\"annotations\":{}},\"fileHandles\":[{\"id\":\"128471088\",\"etag\":\"6cfb8c95-5ea1-45b8-876d-5706031f82a2\",\"createdBy\":\"3324230\",\"createdOn\":\"2023-09-10T05:48:14.000Z\",\"modifiedOn\":\"2023-09-10T05:48:14.000Z\",\"concreteType\":\"org.sagebionetworks.repo.model.file.S3FileHandle\",\"contentType\":\"application/octet-stream\",\"contentMd5\":\"3f466b7f85d184292a68cea1c4f7cfc2\",\"fileName\":\"filec7f27aac4a73\",\"storageLocationId\":1,\"contentSize\":27,\"status\":\"AVAILABLE\",\"bucketName\":\"proddata.sagebase.org\",\"key\":\"3324230/4463b495-99fe-4e36-be89-c93ac80f7536/filec7f27aac4a73\",\"isPreview\":false}]}", -## "entityId": "syn52417545", -## "evaluationId": "9615411", -## "id": "9740522", -## "name": "filec7f27aac4a73", +## "createdOn": "2023-09-10T05:57:52.987Z", +## "entityBundleJSON": "{\"entity\":{\"name\":\"filed50b5eab227e\",\"id\":\"syn52417564\",\"etag\":\"d5abdf9f-f6b6-474b-bf0f-0ffe90c7ad5b\",\"createdOn\":\"2023-09-10T05:57:52.407Z\",\"modifiedOn\":\"2023-09-10T05:57:52.580Z\",\"createdBy\":\"3324230\",\"modifiedBy\":\"3324230\",\"parentId\":\"syn52417563\",\"concreteType\":\"org.sagebionetworks.repo.model.FileEntity\",\"versionNumber\":1,\"versionLabel\":\"1\",\"isLatestVersion\":true,\"dataFileHandleId\":\"128471134\"},\"entityType\":\"file\",\"annotations\":{\"id\":\"syn52417564\",\"etag\":\"00000000-0000-0000-0000-000000000000\",\"annotations\":{}},\"fileHandles\":[{\"id\":\"128471134\",\"etag\":\"9cc8f980-b765-4ee1-808a-7ab6850fb824\",\"createdBy\":\"3324230\",\"createdOn\":\"2023-09-10T05:57:52.000Z\",\"modifiedOn\":\"2023-09-10T05:57:52.000Z\",\"concreteType\":\"org.sagebionetworks.repo.model.file.S3FileHandle\",\"contentType\":\"application/octet-stream\",\"contentMd5\":\"3f466b7f85d184292a68cea1c4f7cfc2\",\"fileName\":\"filed50b5eab227e\",\"storageLocationId\":1,\"contentSize\":27,\"status\":\"AVAILABLE\",\"bucketName\":\"proddata.sagebase.org\",\"key\":\"3324230/9a462b96-fd7c-4e20-9b85-907b46089142/filed50b5eab227e\",\"isPreview\":false}]}", +## "entityId": "syn52417564", +## "evaluationId": "9615412", +## "id": "9740524", +## "name": "filed50b5eab227e", ## "userId": "3324230", ## "versionNumber": 1 ## } ## ## [[1]][[2]] ## { -## "entityId": "syn52417545", -## "etag": "afcbbcc4-c338-47bd-b8b9-60ba6de89ae8", -## "id": "9740522", -## "modifiedOn": "2023-09-10T05:48:15.051Z", +## "entityId": "syn52417564", +## "etag": "321b6d29-eb9a-4dc5-bf58-0ff407b46224", +## "id": "9740524", +## "modifiedOn": "2023-09-10T05:57:52.987Z", ## "status": "RECEIVED", ## "statusVersion": 0, ## "submissionAnnotations": {}, @@ -776,10 +776,10 @@

EvaluationssubmissionStatus <- synGetSubmissionStatus(submission) submissionStatus ## { -## "entityId": "syn52417545", -## "etag": "afcbbcc4-c338-47bd-b8b9-60ba6de89ae8", -## "id": "9740522", -## "modifiedOn": "2023-09-10T05:48:15.051Z", +## "entityId": "syn52417564", +## "etag": "321b6d29-eb9a-4dc5-bf58-0ff407b46224", +## "id": "9740524", +## "modifiedOn": "2023-09-10T05:57:52.987Z", ## "status": "RECEIVED", ## "statusVersion": 0, ## "submissionAnnotations": {}, @@ -830,13 +830,13 @@

Sharing Access to Contentacl <- synSetPermissions(project, principalId = 273949, accessType = list("READ")) acl ## $id -## [1] "syn52417544" +## [1] "syn52417563" ## ## $creationDate -## [1] "2023-09-10T05:48:04.799Z" +## [1] "2023-09-10T05:57:42.595Z" ## ## $etag -## [1] "683b80f2-d8e1-4d08-b0e3-3363b1bc1eec" +## [1] "7205921e-0a24-4b73-a530-4e300bc36b63" ## ## $resourceAccess ## $resourceAccess[[1]] @@ -844,9 +844,9 @@

Sharing Access to Content## [1] 3324230 ## ## $resourceAccess[[1]]$accessType -## [1] "CREATE" "UPDATE" "MODERATE" -## [4] "CHANGE_PERMISSIONS" "DOWNLOAD" "DELETE" -## [7] "CHANGE_SETTINGS" "READ" +## [1] "READ" "CHANGE_SETTINGS" "MODERATE" +## [4] "CREATE" "CHANGE_PERMISSIONS" "DOWNLOAD" +## [7] "UPDATE" "DELETE" ## ## ## $resourceAccess[[2]] diff --git a/docs/articles/tables.html b/docs/articles/tables.html index 75f96292..ad38134f 100644 --- a/docs/articles/tables.html +++ b/docs/articles/tables.html @@ -154,7 +154,7 @@

Tables
 table <- synBuildTable("My Favorite Genes", project, genes)
 table$schema
-## Schema(name='My Favorite Genes', parentId='syn52417546', columnIds=[], concreteType='org.sagebionetworks.repo.model.table.TableEntity', columns_to_store=[{'name': 'Name', 'columnType': 'STRING', 'maximumSize': 30, 'defaultValue': '', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}, {'name': 'Chromosome', 'columnType': 'INTEGER', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}, {'name': 'Start', 'columnType': 'INTEGER', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}, {'name': 'End', 'columnType': 'INTEGER', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}, {'name': 'Strand', 'columnType': 'STRING', 'maximumSize': 30, 'defaultValue': '', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}, {'name': 'TranscriptionFactor', 'columnType': 'BOOLEAN', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}, {'name': 'Time', 'columnType': 'INTEGER', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}])
+## Schema(columnIds=[], concreteType='org.sagebionetworks.repo.model.table.TableEntity', parentId='syn52417565', name='My Favorite Genes', columns_to_store=[{'name': 'Name', 'columnType': 'STRING', 'maximumSize': 30, 'defaultValue': '', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}, {'name': 'Chromosome', 'columnType': 'INTEGER', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}, {'name': 'Start', 'columnType': 'INTEGER', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}, {'name': 'End', 'columnType': 'INTEGER', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}, {'name': 'Strand', 'columnType': 'STRING', 'maximumSize': 30, 'defaultValue': '', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}, {'name': 'TranscriptionFactor', 'columnType': 'BOOLEAN', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}, {'name': 'Time', 'columnType': 'INTEGER', 'concreteType': 'org.sagebionetworks.repo.model.table.ColumnModel'}])

synBuildTable creates a Table Schema based on the data and returns a Table object that can be stored in Synapse using synStore(). To create a custom Table Schema, defines the @@ -225,7 +225,7 @@

Changing Data= c(F, F), Time = as.POSIXlt(c("2070-01-12 03:53:12.169", "2018-05-03 12:03:33.464"), tz = "UTC", format = "%Y-%m-%d %H:%M:%OS")) synStore(Table(tableId, moreGenes)) -## <synapseclient.table.CsvFileTable object at 0x11fef9cf0> +## <synapseclient.table.CsvFileTable object at 0x1268bdcf0>

For example, let’s update the names of some of our favorite genes:

@@ -367,14 +367,14 @@ 

Notes on Dates and Timesdf <- as.data.frame(results) df$Time <- as.POSIXlt("2015-07-04 05:22", tz = "UTC", format = "%Y-%m-%d %H:%M") synStore(Table(tableId, moreGenes)) -## <synapseclient.table.CsvFileTable object at 0x11ff40d90>

+## <synapseclient.table.CsvFileTable object at 0x126b50d90>

Dates may also be submitted in timestamp milliseconds:

 results <- synTableQuery(sprintf("select * from %s where Name='zap'", tableId))
 df <- as.data.frame(results)
 df$Time <- timestamp
 synStore(Table(tableId, moreGenes))
-## <synapseclient.table.CsvFileTable object at 0x11fefb7f0>
+## <synapseclient.table.CsvFileTable object at 0x1268bf7f0>

Note that using POSIXlt is strongly preferred over POSIXct, because POSIXct does not store values with enough precision to reliably recover milliseconds. For more diff --git a/docs/articles/views.html b/docs/articles/views.html index e076efa1..e1b16855 100644 --- a/docs/articles/views.html +++ b/docs/articles/views.html @@ -200,17 +200,17 @@

Views data <- as.data.frame(queryResults) data ## ROW_ID ROW_VERSION ROW_ETAG id -## 1 52417553 1 2c0d0dde-f636-400e-b2d6-5a580f067d7b syn52417553 -## 2 52417554 1 7780b686-11cf-4710-b10d-a133dc52eb17 syn52417554 +## 1 52417572 1 03d6cee4-35c4-4be7-9021-4b12f6eaa755 syn52417572 +## 2 52417573 1 ec739129-fea1-4901-bf71-2611930e94d2 syn52417573 ## name description createdOn createdBy -## 1 fileca573a99ef5 NA 2023-09-09 22:50:02 3324230 -## 2 fileca577502e8b3 NA 2023-09-09 22:50:04 3324230 +## 1 filed79d5e81ba3e NA 2023-09-09 22:59:50 3324230 +## 2 filed79d16ea6ceb NA 2023-09-09 22:59:51 3324230 ## etag modifiedOn modifiedBy type -## 1 2c0d0dde-f636-400e-b2d6-5a580f067d7b 2023-09-09 22:50:04 3324230 file -## 2 7780b686-11cf-4710-b10d-a133dc52eb17 2023-09-09 22:50:05 3324230 file +## 1 03d6cee4-35c4-4be7-9021-4b12f6eaa755 2023-09-09 22:59:52 3324230 file +## 2 ec739129-fea1-4901-bf71-2611930e94d2 2023-09-09 22:59:52 3324230 file ## currentVersion parentId benefactorId projectId dataFileHandleId -## 1 1 syn52417552 syn52417552 syn52417552 128471119 -## 2 1 syn52417552 syn52417552 syn52417552 128471120 +## 1 1 syn52417571 syn52417571 syn52417571 128471165 +## 2 1 syn52417571 syn52417571 syn52417571 128471166 ## dataFileSizeBytes dataFileMD5Hex ## 1 37 47dfe7f5eaa49a5413c7b79b67ab9c43 ## 2 38 ba01e01b9e3ffea3ebef95efa62998b0 @@ -218,8 +218,8 @@

Views ## 1 org.sagebionetworks.repo.model.file.S3FileHandle proddata.sagebase.org ## 2 org.sagebionetworks.repo.model.file.S3FileHandle proddata.sagebase.org ## dataFileKey contributor -## 1 3324230/cce86a31-47f3-43f3-b666-3d6c0be4094c/fileca573a99ef5 Sage -## 2 3324230/de3ad42c-f235-4bae-b294-0a23e91799dc/fileca577502e8b3 UW +## 1 3324230/b4e57ee9-09e5-47eb-b0e7-f72a7286f57f/filed79d5e81ba3e Sage +## 2 3324230/a81a4d30-81bc-47b6-8990-021b9b790207/filed79d16ea6ceb UW ## class rank ## 1 V NA ## 2 NA X @@ -246,7 +246,7 @@

Updating Annotations using View
 data$contributor[1] <- c("Sage Bionetworks")
 synStore(Table(view$properties$id, data[1,]))
-## <synapseclient.table.CsvFileTable object at 0x115009390>
+## <synapseclient.table.CsvFileTable object at 0x11a6d1390>

Update View’s Content diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index ed8ca41d..802446da 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -10,5 +10,5 @@ articles: troubleshooting: troubleshooting.html upload: upload.html views: views.html -last_built: 2023-09-10T05:47Z +last_built: 2023-09-10T05:56Z