r - 创建 R 包时如何使用 roxygen2 编辑 NAMESPACE？

Question

我正在写一个 R 包，在下面的链接中，

How can I load dependencies in an R package?响应表明有必要“在您的 NAMESPACE 文件 importFrom(ncdf4, nc_open) 中添加一行，然后在您的代码中，调用不带包的函数:nc_open(...)”

在这里， How to properly include dependencies in R-package?一位用户说:

“NAMESPACE文件。在这里声明你需要的包

导入(ggplot2)或避免命名空间冲突

importFrom(ggplot2, geom_point)您可以使用 @import 和 @importFrom 标签让 roxygen2 维护 NAMESPACE 文件。”

这些建议看起来很简单。但是，当我使用 r 包 roxygen2 创建 NAMESPACE 时，不能手动编辑 NAMESPACE 文件。

那么，如何编辑NAMESPACE文件呢？

非常感谢您

Answer 1

如果你需要完整的例子，这就是它的样子:

#' Title
#'
#' @return
#' @export
#' @import ggplot2
#' @importFrom data.table setDT
#' @examples
my_function <- function() {
  
}

要插入 roxygen2 骨架 - 转到 RStudio 中的“代码”选项卡并搜索插入 Roxygen 骨架。

tag @export 表示当使用 package::my_fun 时或在 之后，my_function 将被导出以对用户可见库(包)。标记 @import 使所有从 ggplot2 包中导出的函数对你可用，即当你使用函数时不需要使用 ggplot2::aes()从您的包裹中的这个包裹中。标记 @importFrom 仅使包中明确提及的功能可用，即无需使用 package::fun()，但此包中的其他功能将需要它。