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
/
ActivityEventApi: ActivityEvent operations

ActivityEventApi: ActivityEvent operations
In BIDMCDigitalPsychiatry/LAMP-r: API Client for LAMP Platform

Description Format Methods Public fields Methods Examples

Description

LAMP.ActivityEvent

Format

An R6Class generator object

Methods

allByParticipant Get all activity events for a participant. Get the set of all activity events produced by a given participant, by identifier.

allByResearcher Get all activity events for a researcher by participant. Get the set of all activity events produced by participants of any study conducted by a researcher, by researcher identifier.

allByStudy Get all activity events for a study by participant. Get the set of all activity events produced by participants of a single study, by study identifier.

create Create a new ActivityEvent for the given Participant. Create a new ActivityEvent for the given Participant.

delete Delete a ActivityEvent. Delete a ActivityEvent.

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

Method new()

Usage
ActivityEventApi$new(apiClient)

Method allByParticipant()

Usage
ActivityEventApi$allByParticipant(
  participant.id,
  origin = NULL,
  from = NULL,
  to = NULL,
  transform = NULL,
  ...
)

Method allByParticipantWithHttpInfo()

Usage
ActivityEventApi$allByParticipantWithHttpInfo(
  participant.id,
  origin = NULL,
  from = NULL,
  to = NULL,
  transform = NULL,
  ...
)

Method allByResearcher()

Usage
ActivityEventApi$allByResearcher(
  researcher.id,
  origin = NULL,
  from = NULL,
  to = NULL,
  transform = NULL,
  ...
)

Method allByResearcherWithHttpInfo()

Usage
ActivityEventApi$allByResearcherWithHttpInfo(
  researcher.id,
  origin = NULL,
  from = NULL,
  to = NULL,
  transform = NULL,
  ...
)

Method allByStudy()

Usage
ActivityEventApi$allByStudy(
  study.id,
  origin = NULL,
  from = NULL,
  to = NULL,
  transform = NULL,
  ...
)

Method allByStudyWithHttpInfo()

Usage
ActivityEventApi$allByStudyWithHttpInfo(
  study.id,
  origin = NULL,
  from = NULL,
  to = NULL,
  transform = NULL,
  ...
)

Method create()

Usage
ActivityEventApi$create(participant.id, activity.event, ...)

Method createWithHttpInfo()

Usage
ActivityEventApi$createWithHttpInfo(participant.id, activity.event, ...)

Method delete()

Usage
ActivityEventApi$delete(
  participant.id,
  origin = NULL,
  from = NULL,
  to = NULL,
  transform = NULL,
  ...
)

Method deleteWithHttpInfo()

Usage
ActivityEventApi$deleteWithHttpInfo(
  participant.id,
  origin = NULL,
  from = NULL,
  to = NULL,
  transform = NULL,
  ...
)

Method clone()

The objects of this class are cloneable with this method.

Usage
ActivityEventApi$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
## Not run: 
####################  allByParticipant  ####################

library(LAMP)
var.participant.id <- 'participant.id_example' # character | 
var.origin <- 'origin_example' # character | 
var.from <- 3.4 # numeric | 
var.to <- 3.4 # numeric | 

#Get all activity events for a participant.
result <- LAMP.ActivityEvent$allByParticipant(var.participant.id, 
                                             origin=var.origin, 
                                             from=var.from, 
                                             to=var.to)


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

library(LAMP)
var.researcher.id <- 'researcher.id_example' # character | 
var.origin <- 'origin_example' # character | 
var.from <- 3.4 # numeric | 
var.to <- 3.4 # numeric | 

#Get all activity events for a researcher by participant.
result <- LAMP.ActivityEvent$allByResearcher(var.participant.id, 
                                            origin=var.origin, 
                                            from=var.from, 
                                            to=var.to)

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

library(LAMP)
var.study.id <- 'study.id_example' # character | 
var.origin <- 'origin_example' # character | 
var.from <- 3.4 # numeric | 
var.to <- 3.4 # numeric | 

#Get all activity events for a study by participant.
result <- LAMP.ActivityEvent$allByStudy(var.study.id, origin=var.origin, from=var.from, to=var.to)


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

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

#Create a new ActivityEvent for the given Participant.
result <- LAMP.ActivityEvent$create(var.participant.id, var.activity.event)


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

library(LAMP)
var.participant.id <- 'participant.id_example' # character | 
var.origin <- 'origin_example' # character | 
var.from <- 3.4 # numeric | 
var.to <- 3.4 # numeric | 

#Delete a ActivityEvent.
result <- LAMP.ActivityEvent$delete(var.participant.id, origin=var.origin, from=var.from, to=var.to)



## End(Not run)

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

Related to ActivityEventApi 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