如何自动将函数加载到 R 包的命名空间中

Question

我有一个 R 包，它需要来自其他几个包的函数在命名空间中。 使用 roxygen2 文档，我已经成功安装了这些包（即install.packages(dplyr) ），但我无法自动加载它们（即library(dplyr) ）。

这是我的描述文件：

Package: pkgname
Title: What the Package Does (one line, title case)
Version: 0.0.0.9000
Authors@R: person("First", "Last", email = "email@example.com", role = c("aut", "cre"))
Description: What the package does (one paragraph).
Depends: R (>= 3.5.2)
Imports:
  ggplot2,
  zoo,
  tidyr,
  dplyr,
  magrittr
Suggests:
  RColorBrewer
License: What license is it under?
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.1.1

在需要来自 magrittr 的管道函数的我的一个函数的文档末尾，我包含了以下符号：

#' @importFrom magrittr %>%
#'
#' @export
funName <- function(...) { 
... 
} 

另一个功能：

#' @import ggplot2
#' @importFrom magrittr %>%
#'
#' @export
funName2 <- function(...) {
...
}

这成功地显示在我的 NAMESPACE 文件中：

# Generated by roxygen2: do not edit by hand

export(funName2)
export(funName)
import(ggplot2)
importFrom(magrittr,"%>%")

然而，尽管在 roxygen2 注释中添加了符号并且我的 NAMESPACE 文件中的脚本正确，我仍然必须在每个新的 R 会话中使用library(package-name)加载包ggplot2和magrittr 。 我希望dplyr 、 tidyr和zoo这个要求（因为我没有明确加载这些，只需安装它们），但我没有ggplot2或%>%运算符。 我是否错误地导入了它们？

Answer 1

你永远不应该在你的包函数中使用library(package.name) 。 而是使用package.name::function.name() 。 您需要重新导出magrittr管道操作符：

1- 将magrittr放入描述文件（如您所做的那样）

2- 使用以下__imports.R文件创建到包R/目录中：

#' re-export magrittr pipe operator
#'
#' @importFrom magrittr %>%
#' @name %>%
#' @rdname pipe
#' @export
NULL

或者，就像哈德利·威克姆所说的那样：

#' Pipe operator
#'
#' @name %>%
#' @rdname pipe
#' @keywords internal
#' @export
#' @importFrom magrittr %>%
#' @usage lhs \%>\% rhs
NULL

我认为你可以在必要时对其他进口做同样的事情。 尽可能多地使用@importFrom ，否则重新导出它。

Answer 2

尝试运行以下命令将您的包放入 NAMESPACE

devtools::document()

运行后，所有导入的 (@import) 包都将插入到 NAMESPACE 中。

希望能帮助到你 ;）