new.user: New R-API MaveDB User

In jweile/rapimave: R API for MaveDB

Description

Internal constructor that creates an immutable new user object. This function is not exported and should not be called outside of the rapimave package itself. User objects are generated by the getAllUsers() and getUser() methods of a rapimave object (which itself is generated using the new.rapimave() constructor). However, this section explains the functions that are available for these objects.

Usage

new.user(data)

Details

A user object offers the following getter functions:

• getUsername() return the username.

• getFirstName() return the user's first name.

• getLastName() return the user's last name.

• getDisplayName() return the user's preferred display name.

• getExperimentSets() return the ExperimentSets attributed to the user.

• getExperiments() return the Experiments attributed to the user.

• getScoreSets() return the ScoreSets attributed to the user.

Value

a new R-API MaveDB user object.

Examples

## Not run: 
mave <- new.rapimave()
user <- mave$getUser("0000-0003-1474-605X")
cat(user$getFirstName(),user$getLastName())

## End(Not run)

jweile/rapimave documentation built on Aug. 4, 2021, 12:12 a.m.