1- # DolphinDB R包
1+ # R API
22
3- ### 1. 关于DolphinDB R包
3+ DolphinDB 提供了 R API 便于用户通过 R 语言操作 DolphinDB。DolphinDB R API 是由 R 和 C++ 实现的,使用的 C++ 包是 Rcpp。
44
5- #### 1.1 简介
6-
7- DolphinDB提供了R包,用户可以通过R语言操作DolphinDB。DolphinDB R包是由R和C++实现的,使用的C++包是Rcpp。
8-
9- DolphinDB R包支持以下功能:
5+ DolphinDB R API支持以下功能:
106
117- 运行脚本
128- 执行DolphinDB中的函数
139- 上传变量到DolphinDB
1410
15- #### 1.2 依赖
11+ ## 依赖
1612
1713- R ( ≥ 3. 2. 0)
1814- Rcpp ( ≥ 0. 12. 17)
1915
20- ### 2. 安装DolphinDB R包
16+ ## 安装
2117
22- #### 2.1 准备R环境
18+ ### 准备 R 环境
2319
2420- Linux系统:
2521
26- - 执行` sudo apt-get install r-base ` 安装R
27- - 或者从[ R官网] ( https://www.r-project.org/ ) 手动下载安装
22+ - 执行 ` sudo apt-get install r-base ` 安装R
23+ - 或者从 [ R官网] ( https://www.r-project.org/ ) 手动下载安装
2824
2925- Windows系统:
3026
31- - 从[ R官网] ( https://www.r-project.org/ ) 下载并安装R包和rtools
27+ - 从 [ R官网] ( https://www.r-project.org/ ) 下载并安装 R API和 rtools
3228
3329安装时需要配置好环境变量和路径。
3430
35- #### 2.2 进入R命令行
31+ ### 进入 R 命令行
3632
37- 在终端或命令行中输入` R ` 进入R命令行 。
33+ 在终端或命令行中输入 ` R ` 进入 R 命令行 。
3834
39- #### 2.3 安装devtools
35+ ### 安装 devtools
4036
4137在R命令行中输入` install.packages("devtools") ` ,选择最近的镜像下载并安装。
4238
43- #### 2.4 通过devtools安装DolphinDB R包
39+ ### 通过 devtools 安装 DolphinDB R API
4440
45- 在R命令行中输入 ` devtools::install_github("dolphindb/api-r") ` ,系统自动会下载并安装DolphinDB R包以及它所依赖的包 。
41+ 在 R 命令行中输入 ` devtools::install_github("dolphindb/api-r") ` ,系统自动会下载并安装 DolphinDB R API 以及它所依赖的包 。
4642
47- 如果在Windows系统上安装时出现 * Warning in system(cmd) : 'make' not found.* 的错误信息,可以在R命令行中执行以下代码 。安装完成后,程序包将由g++ 自动编译和链接。
43+ 如果在 Windows 系统上安装时出现 * Warning in system(cmd) : 'make' not found.* 的错误信息,可以在 R 命令行中执行以下代码 。安装完成后,程序包将由 g++ 自动编译和链接。
4844
4945 ``` R
5046 Sys.setenv(PATH = paste(" *InstallDirectory*/Rtools/bin" , Sys.getenv(" PATH" ), sep = " ;" ))
5147 Sys.setenv(BINPREF = " *InstallDirectory*/Rtools/mingw_64/bin" )
5248 ```
5349
54- #### 2.5 使用DolphinDB R包
50+ ### 使用DolphinDB R API
5551
56- 假设DolphinDB运行在主机名为localhost,端口号为8848的服务器上,我们可以通过以下方式来连接DolphinDB 、上传对象和执行脚本:
52+ 假设 DolphinDB 运行在主机名为 localhost,端口号为 8848 的服务器上,我们可以通过以下方式来连接 DolphinDB 、上传对象和执行脚本:
5753
5854``` R
5955library(RDolphinDB )
@@ -68,9 +64,37 @@ if (conn@connected) {
6864dbClose(conn )
6965```
7066
71- ### 3. 更多函数介绍
7267
73- 在R命令行中执行** help** 函数可以获取更多DolphinDB R包中函数的用法。
68+ ## 数据类型支持一览
69+
70+ R API 支持的 DolphinDB 数据类型如下:
71+
72+ | DolphinDB类型 | DolphinDB中数据示例 | R语言类型 | R语言中数据示例 | 说明 |
73+ | ---| ---| ---| ---| ---|
74+ | BOOL | false | Logical | FALSE | |
75+ | CHAR | 'A' | Integer | 65 | |
76+ | SHORT | 32 | Integer | 32 | |
77+ | INT | 1 | Integer | 1 | |
78+ | LONG | 100000 | Numeric | 10000 | 因为R的整形最大就是2147483647 |
79+ | DATE | 2013.06.13 | Date | 2013-06-13 | |
80+ | MONTH | 2013.08M | Date | 2013-08-01 | 指定为当月第一天 |
81+ | TIME | 13:30:10.008 | POSIXct | 1970-01-01 13:30:10 | 指定为1970.01.01那天的该时刻 |
82+ | MINUTE | 13:30m | POSIXct | 1970-01-01 13:30:00 | 指定为1970.01.01那天的该时刻 |
83+ | SECOND | 13:30:10 | POSIXct | 1970-01-01 13:30:10 | 指定为1970.01.01那天的该时刻 |
84+ | DATETIME | 2012.06.13T13:30:10 | POSIXct | 2012-06-13 13:30:10 | |
85+ | TIMESTAMP | 2012.06.13T13:30:10.008 | POSIXct | 2012-06-13 13:30:10 | |
86+ | NANOTIME | 13:30:10.008007006 | POSIXct | 1970-01-01 13:30:10 | 指定为1970.01.01那天的该时刻 |
87+ | NANOTIMESTAMP | 2012.06.13T13:30:10.008007006 | POSIXct | 2012-06-13 13:30:10 | |
88+ | FLOAT | 2.1f | Numeric | 2.1 | |
89+ | DOUBLE | 2.1 | Numeric | 2.1 | |
90+ | STRING | “123” | character | “123” | |
91+ | SYMBOL | | 不支持 | | |
92+ | BLOB | | 不支持 | | |
93+ | DATEHOUR | | 不支持 | | |
94+
95+ ## 更多函数介绍
96+
97+ 在R命令行中执行 ` help ` 函数可以获取更多 DolphinDB R API 中函数的用法。
7498
7599``` R
76100# About the package
@@ -85,5 +109,4 @@ help("dbUpload")
85109help(" dbClose" )
86110```
87111
88- 更多关于DolphinDB内置函数的用法,请参考[ DolphinDB用户手册] ( https://www.dolphindb.cn/cn/help/Chapter13FunctionsandCommands.html ) 。
89-
112+ 更多关于 DolphinDB 内置函数的用法,请参考:[ DolphinDB 函数参考] ( https://docs.dolphindb.cn/zh/funcs/funcs_intro.html )
0 commit comments