R API

This is a R-Package which will make it easy for you to handle DolphinDB with R.

It is implemented by R & C++, with the help of package Rcpp.

The package supports :

• Running scripts

• Executing functions with arguments

• Uploading variables

on DolphinDB server, while receiving object from server in the form and type of R.

• R ( ≥ 3. 2. 0)

• Rcpp ( ≥ 0. 12. 17)

##. Install

• For Linux user

  • sudo apt-get install r-base

  • OR download and install manually : https://www.r-project.org/

• For Windows user

  • Download and install the r base packages and the rtools at https://www.r-project.org/

• Type R in your terminal/console.

• You should have set the correct environment variable and path for R.

• In R CMD, type install.packages("devtools") to install package devtools.

• Select the nearest mirror to download and install automatically.

• Make sure the Internet is in good condition.

• In R CMD, type devtools::install_github("dolphindb/api-r").

• This command will automatically download and install RDolphinDB and its dependency package.

• For Windows user

  • If the Installation failed with message: Warning in system(cmd) : 'make' not found. Just try:

  Sys.setenv(PATH = paste("*InstallDirectory*/Rtools/bin", Sys.getenv("PATH"), sep=";"))
  Sys.setenv(BINPREF = "*InstallDirectory*/Rtools/mingw_64/bin") 

• After installation, the package will be compiled and linked by g++ automatically.

• Assume you are running DolphinDB server on localhost:8848

• Then you can use RDolphinDB in the following way

library(RDolphinDB)
conn <- dbConnect(DolphinDB(), "localhost", 8848)
if (conn@connected) {
    dbUpload(conn, c("val1", "val2"), list(3.5, c(1.3, 2.6, 3.7)))
    res_run <- dbRun(conn, "1 2 3")
    res_rpc <- dbRpc(conn, "size", list(c(1, 2, 3)))
    print(res_run)
    print(res_rpc)
}
dbClose(conn)

# About the package
help(package = "RDolphinDB")

# About the functions
help("DolphinDB")
help("dbConnect")
help("dbRun")
help("dbRpc")
help("dbUpload")
help("dbClose")

• www.dolphindb.com/help