utilities: helper utilities for the RXDS API for Truven Health Research...
In xbsd/rxdsapi2: API for RXDS KDB+ Applications
Description
Usage
Arguments
Value
Description
The test_connection function initiates a connection to a target R Server
using the servername and port number. The user simply needs to execute the function
test_connection() which will prompt for the server and port information. The function
then attempts to establish a connection. The user will get a message confirming whether the
connection was successful or otherwise.
Important: The user should never have to run this function except for debugging purposes. Each
function in the API automatically executes this function to test for connectivity. It is intended
to merely indicate the existence of a valid server:port connection.
When this function is executed successfully, it sets 2 global variables:
rxds_api_r_kdb_server: The server name; and
rxds_api_r_kdb_port: The port number of the server
In the event that the connection is not successful, the user may re-execute the function or
contact support for further information.
This function does not accept any parameter.
The reset_connection function resets connection details for a target R server.
When a connection to a target server is established, the system sets 2 global variables (rxds_api_r_kdb_server
and rxds_api_r_kdb_port). This function resets the value of the variables and when the user
attempts to run a new function, it prompts the user for the relevant server/port information
In the event that the connection is not successful, the user may re-execute the function or
contact support for further information.
This function does not accept any parameter.
The get_table_stats combines data from R and KDB+ execution statistics
This is a 'helper' function for other functions in the package and is not intended to be execute
directly by the end user
Usage
1
2
3
4
5
test_connection()
reset_connection()
get_table_stats(RStats, kdbStats, startTime, endTime)
Arguments
RStats
a data table with R connection statistics
kdbStats
a data table with KDB+ connection statistics
startTime
a character value with start time
endTime
a character value with end time
Value
A message confirming the status of the connection attempt
None
a data table with R Stats and KDB+ Stats
xbsd/rxdsapi2 documentation built on May 14, 2019, 11:08 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value
Description
The test_connection function initiates a connection to a target R Server
using the servername and port number. The user simply needs to execute the function
test_connection() which will prompt for the server and port information. The function
then attempts to establish a connection. The user will get a message confirming whether the
connection was successful or otherwise.
Important: The user should never have to run this function except for debugging purposes. Each function in the API automatically executes this function to test for connectivity. It is intended to merely indicate the existence of a valid server:port connection.
When this function is executed successfully, it sets 2 global variables: rxds_api_r_kdb_server: The server name; and rxds_api_r_kdb_port: The port number of the server
In the event that the connection is not successful, the user may re-execute the function or contact support for further information.
This function does not accept any parameter.
The reset_connection function resets connection details for a target R server.
When a connection to a target server is established, the system sets 2 global variables (rxds_api_r_kdb_server
and rxds_api_r_kdb_port). This function resets the value of the variables and when the user
attempts to run a new function, it prompts the user for the relevant server/port information
In the event that the connection is not successful, the user may re-execute the function or contact support for further information.
This function does not accept any parameter.
The get_table_stats combines data from R and KDB+ execution statistics
This is a 'helper' function for other functions in the package and is not intended to be execute
directly by the end user
Usage
1 2 3 4 5 | test_connection()
reset_connection()
get_table_stats(RStats, kdbStats, startTime, endTime)
|
Arguments
RStats |
a data table with R connection statistics |
kdbStats |
a data table with KDB+ connection statistics |
startTime |
a character value with start time |
endTime |
a character value with end time |
Value
A message confirming the status of the connection attempt
None
a data table with R Stats and KDB+ Stats
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.