Project: Constructor for objects of type Project

ProjectR Documentation

Constructor for objects of type Project

Description

Represents a project in Synapse.

Projects in Synapse must be uniquely named. Trying to create a project with a name that's already taken, say 'My project', will result in an error

Usage

Project(name=NULL, properties=NULL, annotations=NULL)

Arguments

name

The name of the project

properties

A named list/vector of Synapse properties. The only valid property name is 'alias'.

annotations

A named list/vector of user defined annotations.

Value

An object of type Project

Examples

## Not run: 
project <- Project('Foobarbat project', properties=c(alias='foobarbat'), annotations=c(foo='bar', bat=101))
project <- synStore(project)
project$properties
project$annotations$foo

## End(Not run)

Sage-Bionetworks/synapseclient documentation built on Feb. 9, 2024, 4:26 p.m.