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
/
SensorApi: Sensor operations

SensorApi: Sensor operations
In BIDMCDigitalPsychiatry/LAMP-r: API Client for LAMP Platform

Description Format Methods Public fields Methods Examples

Description

LAMP.Sensor

Format

An R6Class generator object

Methods

all Get the set of all sensors. Get the set of all sensors.

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

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

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

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

delete Delete a Sensor. Delete a Sensor.

update Update an Sensor's settings. Update an Sensor's settings.

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

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

Method new()

Usage
SensorApi$new(apiClient)

Method all()

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

Method allWithHttpInfo()

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

Method allByParticipant()

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

Method allByParticipantWithHttpInfo()

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

Method allByResearcher()

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

Method allByResearcherWithHttpInfo()

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

Method allByStudy()

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

Method allByStudyWithHttpInfo()

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

Method create()

Usage
SensorApi$create(study.id, sensor, ...)

Method createWithHttpInfo()

Usage
SensorApi$createWithHttpInfo(study.id, sensor, ...)

Method delete()

Usage
SensorApi$delete(sensor.id, ...)

Method deleteWithHttpInfo()

Usage
SensorApi$deleteWithHttpInfo(sensor.id, ...)

Method update()

Usage
SensorApi$update(sensor.id, sensor, ...)

Method updateWithHttpInfo()

Usage
SensorApi$updateWithHttpInfo(sensor.id, sensor, ...)

Method view()

Usage
SensorApi$view(sensor.id, transform = NULL, ...)

Method viewWithHttpInfo()

Usage
SensorApi$viewWithHttpInfo(sensor.id, transform = NULL, ...)

Method clone()

The objects of this class are cloneable with this method.

Usage
SensorApi$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 sensors.
result <- LAMP.Sensor$all()


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

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

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


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

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

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


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

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

#View all sensors in a study.
result <- LAMP.Sensor$allByStudy(var.study.id)


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

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

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


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

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

#Delete a Sensor.
result <- LAMP.Sensor$delete(var.sensor.id)


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

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

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


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

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

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



## End(Not run)

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

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