getStudies: Obtain a list of studies present in the tranSMART database

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

Description

This function will retrieve a list of all studies contained within the currently accessed tranSMART database. A study-name filter is optional.

Usage

getStudies(name.match = "", as.data.frame = TRUE, cull.columns = TRUE)

Arguments

name.match	a character string or regular expression by which the results are filtered. The function will select all studies which name contains the string or matches the regular expression that is supplied.
as.data.frame	logical. If TRUE (default setting) the subject information is coerced to a data.frame. If set to FALSE the function returns the information as a list
cull.columns	logical. If TRUE (default setting) several non-essential columns are excluded.

Details

Depending on your connection characteristics, this may take some time.

Value

A data.frame is returned, whereby each row corresponds to a study in the tranSMART database.

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

getConcepts, getSubjects, getObservations, getHighdimData.

Examples

  ## Not run: 
  # Simply calling the function without an argument will retrieve
  # a data.frame with information on all studies
  getStudies()

  # Supplying a string will act as a filter on the study names,
  # only returning results which contain this string or match the 
  # regular expression. This example will only show studies that
  # start with "foo" in their name.
  getStudies("^foo")
  
## End(Not run)

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