update error messaging and docs

Author: Sergey Vidyuk

R/rkdb.R

@@ -4,7 +4,7 @@
 #' @param port Port number.
 #' @param user Username and password as user:password string
 #' @param timeout Number of milliseconds to wait for connection
-#' @param tls Wether or not to use secure connection. Alway false(unsupported).
+#' @param tls Whether or not to use secure connection. Alway false(unsupported).
 #' @return Handle to kdb+ instance for \code{execute} and \code{close_connection}.
 #' @export
 #' @examples
@@ -20,9 +20,9 @@ open_connection <- function(host="localhost", port=5000, user="", timeout = 0,
 
 #' Execute \code{query} using \code{connection} connection to kdb+.
 #'
-#' @param connection Connection handle. handle>0 will perform sync requst, handle<0 async.
+#' @param connection Connection handle. handle>0 will perform sync request, handle<0 async.
 #' @param query A string to send to kdb+.
-#' @param ... Optional parameters to pass to function provided in query.
+#' @param ... Optional parameters to pass to function provided in the query.
 #' @return Result of execution.
 #' @export
 #' @examples
@@ -49,11 +49,3 @@ execute <- function(connection, query, ...) {
 close_connection <- function(con) {
 	.Call("kx_r_close_connection", as.integer(con))
 }
-
-# library(rkdb)
-# hdl=open_connection(port=4537)
-# tmp <- data.frame(a=c(1,2,3),b=c("a","b","b"))
-# class(tmp$b)
-# dict()
-# class(tmp)
-# execute(hdl,'{`tmp set x}',data.frame(a=c(1,2,3),b=c("a","b","b")))

doc/README.Rmd

@@ -44,7 +44,7 @@ if(! 'devtools' %in% rownames(installed.packages())) install.packages('devtools'
 library(devtools)
 # install rkdb
 devtools::install_github('kxsystems/rkdb', quiet=TRUE)
-# to install rkdb of perticular release
+# to install rkdb of particular release
 # devtools::install_github('kxsystems/[email protected]', quiet=TRUE)
 library(rkdb)
 ```
@@ -58,7 +58,7 @@ q -p params$port
 
 Open a connection to it
 ```{r open connection, echo=TRUE}
-h <- open_connection(params$server,params$port) #this open a connection
+h <- open_connection(params$server,params$port) #this opens a connection
 ```
 
 ## Hello kdb
@@ -114,7 +114,7 @@ cat("
 
 ## Computing on kdb
 
-rkdb provides a convienient way to retrieve computation done on the kdb side so you can have the best of both worlds:
+rkdb provides a convenient way to retrieve computation done on the kdb side so you can have the best of both worlds:
 ```{r kdb side example 1, echo=TRUE, warning=FALSE, message=FALSE}
 kdb <- '
 t: ([] x:1000#`a`b`c;y:1000#1f*til 10;z:1000#1f*til 4);
@@ -138,7 +138,7 @@ plot(DF$y, DF$z, main='scatter plot', xlab='y values', ylab='z values')
 # Getting data from R to kdb
 ## Evaluating kdb expressions using R objects
 
-You can call kdb functions on R objects, those will be passed/converted to the kdb side, and the kdb expression will be evaluated:
+You can call kdb functions with R objects as arguments, those will be passed and converted to native kdb+ data types, and the kdb expression will be evaluated:
 ```{r use r obj 1, echo=TRUE}
 execute(h, "raze", list(c(1,2,3), c(4,5,6)))
 execute(h, "+", 2, 5)

man/execute.Rd

@@ -28,7 +28,7 @@ SEXP kx_r_open_connection(SEXP whence) {
   char *host,*user;
   int length= GET_LENGTH(whence);
   if(length != 5)
-    error("Expecting 5 parameters: host, port, user, timeout, tls. Got ",length);
+    error("Expecting 5 parameters: host, port, user, timeout, tls. Got %d.",length);
 
   host= (char *) CHARACTER_VALUE(VECTOR_ELT(whence, 0));
   port= INTEGER_POINTER(VECTOR_ELT(whence, 1))[0];
@@ -37,9 +37,9 @@ SEXP kx_r_open_connection(SEXP whence) {
 
   connection= khpun(host, port, user,timeout);
   if(!connection)
-    error("Could not authenticate");
+    error("Could not authenticate.");
   else if(connection ==-2 )
-    error("Connection timed out");
+    error("Connection timed out.");
   else if(connection ==-1 ) {
 #ifdef WIN32
     char buf[256];
@@ -82,10 +82,10 @@ SEXP kx_r_execute(SEXP connection, SEXP query, SEXP args) {
   size_t nargs= LENGTH(args);
 
   if(nargs > 8) {
-    error("Error: kdb+ functions take a maximum of 8 parameters");
+    error("kdb+ functions take a maximum of 8 parameters.");
   }
   if(TYPEOF(query) != STRSXP) {
-    error("Error: supplied query or function name must be a string");
+    error("Supplied query or function name must be a string.");
   }
   query_str= (char *) CHARACTER_VALUE(query);
   K kargs[8]= { (K) 0 };
@@ -97,14 +97,14 @@ SEXP kx_r_execute(SEXP connection, SEXP query, SEXP args) {
             kargs[4], kargs[5], kargs[6], kargs[7], (K) 0);
 
   if(0 == result) {
-    error("Error: not connected to kdb+ server\n");
+    error("Not connected to kdb+ server.");
   } else if(kx_connection < 0) { // async IPC
     return R_NilValue;
   } else if(-128 == result->t) {
     char *e= calloc(strlen(result->s) + 1, 1);
     strcpy(e, result->s);
     r0(result);
-    error("Error from kdb+: `%s\n", e);
+    error("kdb+ : %s.", e);
   }
   s= from_any_kobject(result);
   r0(result);