写 R 包教程

R · R 包开发 | 保姆级教程-CSDN博客

https://www.prestevez.com/post/r-package-tutorial/

1、加载开发所需 R 包

library(usethis)

library(devtools)

library(roxygen2)

2、在当前工作路径创建 R 包

usethis::create_package("myRpkg")      # 在当前路径创建 myRpkg/ 文件夹（包框架）

3、打开项目文件

# 进入 myRpkg/ 目录

# 打开 myRpkg.Rproj

4、写函数及函数注释框架

#  1、在 myRpkg/R/ 下创建 R 脚本

#  2、写好函数后光标放在函数内部

#  3、菜单栏--code--Insert Roxygen Skeleton

#          或

#       快捷键 Ctrl + Alt + Shift +R

5、引用 R 包

# 当我们的包依赖于其它包/函数时，需要说明，以在函数安装及调用过程中正确处理

# 用法

# usethis::use_package(package = "<packages name>",

#                                                        type = "<type>",

#                                                        min_version)

# type: Imports、Depends 或 Suggests

# 1、只需要引用包中的某个函数，在你的函数中需 通过：package::fun() 使用

usethis::use_package(package = "<packages name>", type = "Imports")

# 2、完全依赖于某个包，安装时会自动下载

usethis::use_package(package = "<packages name>", type = "Depends")

#  3、建议下载 (安装过程中不会安装此包)，通常是代码示例需要

usethis::use_package(package = "<packages name>", type = "Suggests")

6、封装 R 包

# 1、生成文档

#  即从函数的代码和注释中生成标准化的帮助文档文件、以及 namespace 文件

devtools::document()

# 2、构建

#  即将以上所有文件，以及各部分关系构建成一个可供使用的 R包，输出在当前工作路径

devtools::build()

# 3、安装

#  菜单栏 --- build --- Install Package

# 此方法不生成安装包（tar.gz）

现在就可以使用了！！