Rblpapi (version 0.3.10)

defaultConnection: Return the default connection object

Description

This function return the default connection object from the package environment. If no default connection has been established yet, an error message is shown,

Usage

defaultConnection()

Details

For the connection object, the required arguments host and port argument can be set via options. In addition, if an additional option blpAutoConnect is set to ‘TRUE’, a connection is established in the .onAttach() function and stored in the package environment. This effectively frees users from having to explicitly create such an object. Of course, the user can also call blpConnect explicitly and store the connection object. This helper function looks up the stored connection object and returns it. In case no connection has been established, and error message is shown.

Examples

# NOT RUN {
  con <- defaultConnection()  
# }