创建R包基本流程

1. 建立R包开发环境

• 进入Rstudio界面，依次点击File → New project → New Directory → R package,填写好R包名字，选择好开发包的工作目录（其它暂时都不用考虑）；最后点击Creat Project即可。

• 完成后会自动生成以下文件：

  （1）R 文件夹：用于存放R函数脚本的文件夹；里面有一个示例文件hello.R
  （2）man 文件夹：用于存放对应上述R函数的说明文档Rd文件的文件夹；里面有一个示例文件hello.Rd。
  （3）DESCRIPTION：关于R包的说明文档。
  （4）NAMESPACE：声明R包导出以供外部使用的函数以及R包从其他包导入的外部函数。

  其中，只有R函数脚本与DESCRIPTION需要我们细心准备外，其它可通过一些办法自动写入、更新。

2. 编写函数

• 在R文件夹内创建后缀名为.R的函数脚本，编写自定义的函数

• 把鼠标放置在函数名上，按Ctrl+Alt+Shift+R组合快捷键为函数添加说明文档模板。

• 最后使用一下代码来生成帮助文档（man文件夹里的Rd文件）

devtools::document()

3. 编写DESCRIPTION文件

• 手动修改Version（版本号）、Title（包的名字），Authors@R（作者名）、Description（包的简要描述）

• 使用下述函数，自动编写License部分。如果没有依赖到别的具有不同版权的第三方包的话，一般选择最为广泛使用的 MIT 即可

usethis::use_mit_license()

• 补充依赖包的信息。包括Depends、Imports、Suggests。

  1. Depends是最强的依赖，即在library的同时也library所依赖的包，在使用被引函数的时候不用加::，但可能会引起函数名冲突，慎用。
  2. Imports：如果只需要使用包中的某个函数，而不是整个包，那么引用类型就是Imports。在函数脚本中，必须按照package::function，如dplyr::filter()的形式。
  3. Suggests：如果没有引用和依赖关系，仅仅是在例子中使用了该包，那么我们仅仅是建议安装这个包，这个时候的关系是“Suggests（建议）”。

  例如，在函数中用到了dplyr的filter()函数，则要使用以下代码将dplyr设为依赖：

usethis::use_package(package, type = "Imports", min_version = NULL)

• 单独使用Imports、Depends和Suggests引用的都是CRAN上的包，如果想引用Bioconductor上的包，需要在前面加上biocViews:

image.png

• R包本地安装测试

devtools::install_local('path_to_Rpackage',force = T)

---

参考：

https://www.jianshu.com/p/c0216f42edc5