Views

KimYen Ladia

2019-05-30

Views

A view is a view of all entities (File, Folder, Project, Table, Docker Repository, View) within one or more Projects or Folders. Views can:

  • Provide a way of isolating or linking data based on similarities
  • Provide the ability to link entities together by their annotations
  • Allow view/editing entities attributes in bulk
  • Allow entities to be easily searched and queried

Preliminaries:

library(synapser)
## 
## TERMS OF USE NOTICE:
##   When using Synapse, remember that the terms and conditions of use require that you:
##   1) Attribute data contributors when discussing these data or results from these data.
##   2) Not discriminate, identify, or recontact individuals or groups represented by the data.
##   3) Use and contribute only data de-identified to HIPAA standards.
##   4) Redistribute data only under these same terms of use.
synLogin()
## Welcome, test!
## NULL
# Create a new project
# use hex_digits to generate random string
hex_digits <- c(as.character(0:9), letters[1:6])
projectName <- sprintf("My unique project %s", paste0(sample(hex_digits, 32, replace = TRUE), collapse = ""))
project <- Project(projectName)
project <- synStore(project)

# Create some files
filePath <- tempfile()
connection <- file(filePath)
writeChar("this is the content of the first file", connection, eos = NULL)
close(connection)
file <- File(path = filePath, parent = project)
file <- synStore(file)
## ################################################## Uploading file to Synapse storage ##################################################
Uploading [--------------------]0.00%   0.0bytes/37.0bytes  file5f3d5b85cc16     
Uploading [####################]100.00%   37.0bytes/37.0bytes (259.0bytes/s) file5f3d5b85cc16 Done...

filePath2 <- tempfile()
connection2 <- file(filePath2)
writeChar("this is the content of the second file", connection, eos = NULL)
close(connection2)
file2 <- File(path = filePath2, parent = project)
file2 <- synStore(file2)
## ################################################## Uploading file to Synapse storage ##################################################
Uploading [--------------------]0.00%   0.0bytes/38.0bytes  file5f3d51008160     
Uploading [####################]100.00%   38.0bytes/38.0bytes (255.0bytes/s) file5f3d51008160 Done...

# add some annotations
synSetAnnotations(file, list(contributor = "Sage", class = "V"))
## $class
## $class[[1]]
## [1] "V"
## 
## 
## $contributor
## $contributor[[1]]
## [1] "Sage"
synSetAnnotations(file2, list(contributor = "UW", rank = "X"))
## $rank
## $rank[[1]]
## [1] "X"
## 
## 
## $contributor
## $contributor[[1]]
## [1] "UW"

Creating a View:

view <- EntityViewSchema(name = "my first file view",
                         columns = c(
                           Column(name = "contributor", columnType = "STRING"),
                           Column(name = "class", columnType = "STRING"),
                           Column(name = "rank", columnType = "STRING")),
                         parent = project$properties$id,
                         scopes = project$properties$id,
                         includeEntityTypes = c(EntityViewType$FILE, EntityViewType$FOLDER),
                         add_default_columns = TRUE)

view <- synStore(view)

We support the following entity type in a View:

EntityViewType
## $DOCKER
## EntityViewType.DOCKER
## 
## $FILE
## EntityViewType.FILE
## 
## $FOLDER
## EntityViewType.FOLDER
## 
## $PROJECT
## EntityViewType.PROJECT
## 
## $TABLE
## EntityViewType.TABLE
## 
## $VIEW
## EntityViewType.VIEW

To see the content of your newly created View, use synTableQuery():

queryResults <- synTableQuery(sprintf("select * from %s", view$properties$id))
## 
 [####################]100.00%   1/1   Done...    
Downloading  [####################]100.00%   715.0bytes/715.0bytes (609.2kB/s) Job-877906868588951986297111.csv Done...
data <- as.data.frame(queryResults)
data
##     ROW_ID ROW_VERSION                             ROW_ETAG          id
## 1 10072874           1 9926e2df-1949-42ba-a3e5-0a7c28ad8117 syn10072874
## 2 10072875           1 d6835f79-cbdc-42a3-8bfb-86d26d2c6e3c syn10072875
##               name           createdOn createdBy
## 1 file5f3d5b85cc16 2019-05-30 18:55:28   3323505
## 2 file5f3d51008160 2019-05-30 18:55:29   3323505
##                                   etag type currentVersion    parentId
## 1 9926e2df-1949-42ba-a3e5-0a7c28ad8117 file              1 syn10072873
## 2 d6835f79-cbdc-42a3-8bfb-86d26d2c6e3c file              1 syn10072873
##   benefactorId   projectId          modifiedOn modifiedBy dataFileHandleId
## 1  syn10072873 syn10072873 2019-05-30 18:55:29    3323505           654265
## 2  syn10072873 syn10072873 2019-05-30 18:55:29    3323505           654266
##   contributor class rank
## 1        Sage     V <NA>
## 2          UW  <NA>    X

Updating Annotations using View

To update ‘class’ annotation for ‘file2’, simply update the view:

data["class"] <- c("V", "VI")
synStore(Table(view$properties$id, data))

The change in annotations reflect in synGetAnnotations():

synGetAnnotations(file2$properties$id)

Update View’s Content

A view can contain different types of entity. To change the types of entity that will show up in a view:

view <- synGet(view$properties$id)
view$set_entity_types(list(EntityViewType$FILE))
## NULL

A View is a Table. Please visit Tables vignettes to see how to change schema, update content, and other operations that can be done on View.

synDelete(project)
## NULL