R包编写流程

文章目录

  • 所需工具
  • Step 1: 创建R项目
  • Step 2: 在R文件夹中添加函数
  • Step 3: 编辑元数据
  • Step 4: 文档化
  • Step 5: 检查包
  • Step 6: 打包
  • 重要参考:

所需工具

R包的编写需要的工具包有:devtools,Rtools

Step 1: 创建R项目

devtools::create_package(地址)

执行上述代码后将在制定地址下创建R包项目,其中包含:
.gitignore, .Rbuildignore, DESCRIPTION, NAMESPACE, R文件夹, mathmodels.Rproj等文件

Step 2: 在R文件夹中添加函数

use_r(“R函数名”)

执行之后,将在R文件夹下生成相应名称的R脚本文件,在该脚本文件中写相应的代码。
注意,在代码中不要使用library(), require(), source(), 随后在文件头的地方用@importpackage或者@importFrom即可

写完函数后,Code->Insert roxygen skeleton,可生成函数头,并编辑相应的内容

Step 3: 编辑元数据

编辑DESCRIPTION文件。
这时,把程序运行所需的包通过下面的方法添加到DECRIPTION中:

use_package("包名")

选择许可:

use_agpl3_license()

Step 4: 文档化

通过下面的代码生成man文件内所需的文档:

document()

Step 5: 检查包

通过下面的函数对R包进行验验:

check()

Step 6: 打包

通过下面的代码,将R项目打包成gr.tz文件包:

build()

重要参考:

https://blog.csdn.net/Robby_Wu/article/details/120115877
https://www.jianshu.com/p/c0216f42edc5
https://blog.csdn.net/qq_42631514/article/details/120715764

你可能感兴趣的:(R,个人开发)