getPatientSet: Download a patient set by id.

In transmart/RInterface: R Client for accessing the tranSMART RESTful API

Description

This function retrieves information about a patient set, including the patients in that set.

Usage

getPatientSet(id)

Arguments

id	an integral number, the id of the patient set

The function will return a named list with properties of the patient set. Patient sets are created in the Transmart web interface or with the getPatientSetId call (still to be implemented). Currently there is no support in the legacy Transmart web interface to view the id of a patient set, but the new web app will support that.

Value

A named list with properties of the patient set. The patients element contains a list of patients.

Note

To be able to access a transmart database, you need to be connected to the server the database is on. If you haven't connected to the server yet, establish a connection using the connectToTransmart function.

Author(s)

Jan Kanis. Contact: [e-mail]

See Also

getSubjects

Examples

## Not run: 
    # The following will retrieve information on the patient set with id 28714
    getPatientSet(28714)
    
## End(Not run)

transmart/RInterface documentation built on May 31, 2019, 7:45 p.m.