StudyApi: Study operations

In BIDMCDigitalPsychiatry/LAMP-r: API Client for LAMP Platform

Description

LAMP.Study

Format

An R6Class generator object

Methods

all Get the set of all studies. Get the set of all studies.

• @param transform character

• status code : 200 | 200 Success

• return type : array[object]

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

allByResearcher Get the set of studies for a single researcher. Get the set of studies for a single researcher.

• @param researcher.id character

• @param transform character

• status code : 200 | 200 Success

• return type : array[object]

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

create Create a new Study for the given Researcher. Create a new Study for the given Researcher.

• @param researcher.id character

• @param study Study

• status code : 200 | 200 Success

• return type : character

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

delete Delete a study. Delete a study.

• @param study.id character

• status code : 200 | 200 Success

• return type : character

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

update Update the study. Update the study.

• @param study.id character

• @param study Study

• status code : 200 | 200 Success

• return type : character

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

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

• @param study.id character

• @param transform character

• status code : 200 | 200 Success

• return type : array[object]

• response headers :

• status code : 400 | 400 Bad Request

• return type : Error

• response headers :

• status code : 403 | 403 Authorization Failed

• return type : Error

• response headers :

• status code : 404 | 404 Not Found

• return type : Error

• response headers :

• status code : 0 | 500 Internal Error

• return type : Error

• response headers :

Public fields

apiClient

Handles the client-server communication.

Methods

Public methods

• StudyApi$new()

• StudyApi$all()

• StudyApi$allWithHttpInfo()

• StudyApi$allByResearcher()

• StudyApi$allByResearcherWithHttpInfo()

• StudyApi$create()

• StudyApi$createWithHttpInfo()

• StudyApi$delete()

• StudyApi$deleteWithHttpInfo()

• StudyApi$update()

• StudyApi$updateWithHttpInfo()

• StudyApi$view()

• StudyApi$viewWithHttpInfo()

• StudyApi$clone()

---

Method new()

Usage

StudyApi$new(apiClient)

---

Method all()

Usage

StudyApi$all(transform = NULL, ...)

---

Method allWithHttpInfo()

Usage

StudyApi$allWithHttpInfo(transform = NULL, ...)

---

Method allByResearcher()

Usage

StudyApi$allByResearcher(researcher.id, transform = NULL, ...)

---

Method allByResearcherWithHttpInfo()

Usage

StudyApi$allByResearcherWithHttpInfo(researcher.id, transform = NULL, ...)

---

Method create()

Usage

StudyApi$create(researcher.id, study, ...)

---

Method createWithHttpInfo()

Usage

StudyApi$createWithHttpInfo(researcher.id, study, ...)

---

Method delete()

Usage

StudyApi$delete(study.id, ...)

---

Method deleteWithHttpInfo()

Usage

StudyApi$deleteWithHttpInfo(study.id, ...)

---

Method update()

Usage

StudyApi$update(study.id, study, ...)

---

Method updateWithHttpInfo()

Usage

StudyApi$updateWithHttpInfo(study.id, study, ...)

---

Method view()

Usage

StudyApi$view(study.id, transform = NULL, ...)

---

Method viewWithHttpInfo()

Usage

StudyApi$viewWithHttpInfo(study.id, transform = NULL, ...)

---

Method clone()

The objects of this class are cloneable with this method.

Usage

StudyApi$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
####################  all  ####################

library(LAMP)

#Get the set of all studies.
result <- LAMP.Study$all()


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

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

#Get the set of studies for a single researcher.
result <- LAMP.Study$allByResearcher(var.researcher.id)


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

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

#Create a new Study for the given Researcher.
result <- LAMP.Study$create(var.researcher.id, var.study)


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

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

#Delete a study.
result <- LAMP.Study$delete(var.study.id)


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

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

#Update the study.
result <- LAMP.Study$update(var.study.id, var.study)


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

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

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



## End(Not run)

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