A EntityViewSchema is a Entity that displays all files/projects (depending on user choice) within a given set of scopes

EntityViewSchema(name=NULL, columns=NULL, parent=NULL, scopes=NULL, type=NULL, addDefaultViewColumns=TRUE, addAnnotationColumns=TRUE, ignoredAnnotationColumnNames=list(), properties=NULL, annotations=NULL)

Arguments

name

the name of the Entity View Table object

columns

a list of Column objects or their IDs. These are optional.

parent

the project in Synapse to which this table belongs

scopes

a list of Projects/Folders or their ids

type

the type of EntityView to display: either 'file','project' or 'file_and_table'. Defaults to 'file'.

addDefaultViewColumns

If true, adds all default columns (e.g. name, createdOn, modifiedBy etc.) Defaults to TRUE.
The default columns will be added after a call to synStore.

addAnnotationColumns

If true, adds columns for all annotation keys defined across all Entities in the EntityViewSchema's scope. Defaults to TRUE.
The annotation columns will be added after a call to synStore.

ignoredAnnotationColumnNames

A list of strings representing annotation names. When addAnnotationColumns is TRUE,
the names in this list will not be automatically added as columns to the EntityViewSchema
if they exist in any of the defined scopes.

properties

A map of Synapse properties

annotations

A map of user defined annotations

Details

Value

An object of type EntityViewSchema

References

Note

See also

Examples

# NOT RUN {
project_or_folder <- synGet("syn123")
schema <- EntityViewSchema(name='MyFileView', parent=project, scopes=c(project_or_folder$properties$id, 'syn456'), view_type='file')
schema <- synStore(schema)
# }