connectToTransmart: Initializes a new connection to the tranSMART database via...
In thehyve/heim-RInterface: R Client for accessing the tranSMART RESTful API

Description Usage Arguments Details Author(s) See Also Examples

This function initializes the necessary connection settings to access the tranSMART database.

1	connectToTransmart(transmartDomain, use.authentication = TRUE, ...)

`transmartDomain`	a character string naming the domain of the tranSMART server to connect to.
`use.authentication`	logical indicating whether or not to use OAuth authentication. Must be TRUE (default setting) if the tranSMART server requires OAuth authentication
`...`	additional arguments to be passed on to `authenticateWithTransmart`

This function initialises the connection settings to a tranSMART server. It will set up the connection settings inside the transmartClientEnv environment (if non-existent, this environment is created), which will enable this R client to access the tranSMART database through the available get methods (eg. getStudies).

If use.authentication is not disabled, it will also guide the user through the authentication process.

Tim Dorscheidt, Jan Kanis, Rianne Jansen. Contact: development@thehyve.nl

getStudies.

For more information about the transmart RClient package and what it can be used for: transmartRClient-package

## Not run: 
  
  # Set the function's \code{transmartDomain} argument to the location of the tranSMART database: 
  localTransmartDomain <- "http://some.transmart.server/transmart"
  connectToTransmart(localTransmartDomain)
  
  # Follow the instructions for authentication.
  
## End(Not run)