getSubjects: Obtain a list of all subjects in a certain study.

In thehyve/heim-RInterface: R Client for accessing the tranSMART RESTful API

Description

This function will retrieve a list of all subjects and their personal information for a certain study.

Usage

getSubjects(study.name, as.data.frame = TRUE)

Arguments

study.name	a character string giving the name of a study
as.data.frame	logical. If TRUE (default setting) the subject information is returned as a data.frame. If set to FALSE the function returns the information as a list.

Details

The function will return for each subject the subjectID and their personal information, such as for example sex, age and ethnicity.

Value

A data.frame (or list) is returned, whereby each row (or list element) contains the information partaining to one subject.

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)

Tim Dorscheidt, Jan Kanis, Rianne Jansen. Contact: [e-mail]

See Also

getStudies

Examples

## Not run: 
    # The following will retrieve a data.frame with subject-information for the study "foo"
    getSubjects("foo")
    
## End(Not run)

thehyve/heim-RInterface documentation built on May 31, 2019, 9:12 a.m.