BIDMCDigitalPsychiatry/LAMP-r
API Client for LAMP Platform

Package index
Search the BIDMCDigitalPsychiatry/LAMP-r package
Vignettes
Functions
33
Source code
64
Man pages
33
Home
/
GitHub
/
BIDMCDigitalPsychiatry/LAMP-r
/
ActivityApi: Activity operations

ActivityApi: Activity operations
In BIDMCDigitalPsychiatry/LAMP-r: API Client for LAMP Platform

Description Format Methods Public fields Methods Examples

Description

LAMP.Activity

Format

An R6Class generator object

Methods

all Get the set of all activities. Get the set of all activities.

allByParticipant Get all activities for a participant. Get the set of all activities available to a participant, by participant identifier.

allByResearcher Get all activities for a researcher. Get the set of all activities available to participants of any study conducted by a researcher, by researcher identifier.

allByStudy Get all activities in a study. Get the set of all activities available to participants of a single study, by study identifier.

create Create a new Activity under the given Study. Create a new Activity under the given Study.

delete Delete an Activity. Delete an Activity.

update Update an Activity's settings. Update an Activity's settings.

view Get a single activity, by identifier. Get a single activity, by identifier.

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

Method new()

Usage
ActivityApi$new(apiClient)

Method all()

Usage
ActivityApi$all(transform = NULL, ...)

Method allWithHttpInfo()

Usage
ActivityApi$allWithHttpInfo(transform = NULL, ...)

Method allByParticipant()

Usage
ActivityApi$allByParticipant(participant.id, transform = NULL, ...)

Method allByParticipantWithHttpInfo()

Usage
ActivityApi$allByParticipantWithHttpInfo(participant.id, transform = NULL, ...)

Method allByResearcher()

Usage
ActivityApi$allByResearcher(researcher.id, transform = NULL, ...)

Method allByResearcherWithHttpInfo()

Usage
ActivityApi$allByResearcherWithHttpInfo(researcher.id, transform = NULL, ...)

Method allByStudy()

Usage
ActivityApi$allByStudy(study.id, transform = NULL, ...)

Method allByStudyWithHttpInfo()

Usage
ActivityApi$allByStudyWithHttpInfo(study.id, transform = NULL, ...)

Method create()

Usage
ActivityApi$create(study.id, activity, ...)

Method createWithHttpInfo()

Usage
ActivityApi$createWithHttpInfo(study.id, activity, ...)

Method delete()

Usage
ActivityApi$delete(activity.id, ...)

Method deleteWithHttpInfo()

Usage
ActivityApi$deleteWithHttpInfo(activity.id, ...)

Method update()

Usage
ActivityApi$update(activity.id, activity, ...)

Method updateWithHttpInfo()

Usage
ActivityApi$updateWithHttpInfo(activity.id, activity, ...)

Method view()

Usage
ActivityApi$view(activity.id, transform = NULL, ...)

Method viewWithHttpInfo()

Usage
ActivityApi$viewWithHttpInfo(activity.id, transform = NULL, ...)

Method clone()

The objects of this class are cloneable with this method.

Usage
ActivityApi$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
## Not run: 
####################  all  ####################

library(LAMP)

#Get the set of all activities.
result <- LAMP.Activity$all()


####################  allByParticipant  ####################

library(LAMP)
var.participant.id <- 'participant.id_example' # character | 

#Get all activities for a participant.
result <- LAMP.Activity$allByParticipant(var.participant.id)


####################  allByResearcher  ####################

library(LAMP)
var.researcher.id <- 'researcher.id_example' # character | 

#Get all activities for a researcher.
result <- LAMP.Activity$allByResearcher(var.researcher.id)


####################  allByStudy  ####################

library(LAMP)
var.study.id <- 'study.id_example' # character | 

#Get all activities in a study.
result <- LAMP.Activity$allByStudy(var.study.id)


####################  create  ####################

library(LAMP)
var.study.id <- 'study.id_example' # character | 
var.activity <- Activity$new() # Activity | 

#Create a new Activity under the given Study.
result <- LAMP.Activity$create(var.study.id, var.activity)


####################  delete  ####################

library(LAMP)
var.activity.id <- 'activity.id_example' # character | 

#Delete an Activity.
result <- LAMP.Activity$delete(var.activity.id)


####################  update  ####################

library(LAMP)
var.activity.id <- 'activity.id_example' # character | 
var.activity <- Activity$new() # Activity | 

#Update an Activity's settings.
result <- LAMP.Activity$update(var.activity.id, var.activity)


####################  view  ####################

library(LAMP)
var.activity.id <- 'activity.id_example' # character | 

#Get a single activity, by identifier.
result <- LAMP.Activity$view(var.activity.id)



## End(Not run)

BIDMCDigitalPsychiatry/LAMP-r documentation built on April 29, 2020, 9:51 a.m.

Related to ActivityApi in BIDMCDigitalPsychiatry/LAMP-r...

BIDMCDigitalPsychiatry/LAMP-r index
README.md

R Package Documentation

rdrr.io home R language documentation Run R code online

Browse R Packages

CRAN packages Bioconductor packages R-Forge packages GitHub packages

We want your feedback!

Note that we can't provide technical support on individual packages. You should contact the package authors for that.
GitHub issue tracker
ian@mutexlabs.com
Personal blog

 
Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.

Close