如何在创建R包时使用roxygen2编辑NAMESPACE



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

如何在R包中加载依赖项?响应指示有必要";在NAMESPACE文件importFrom(ncdf4,nc_open(中添加一行,然后在代码中,调用不带包的函数:nc_open(…(">

在这里,如何在R-包中正确地包含依赖项?用户说:

"NAMESPACE文件。在这里申报您需要的包裹

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

importFrom(ggplot2,geom_point(您可以让roxygen2使用@import和@importFrom标记来维护NAMESPACE文件">

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

那么,如何编辑文件NAMESPACE?

非常感谢您提前

如果您需要完整的示例,以下是它的外观:

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

}

要插入roxygen2骨架,请转到";代码";选项卡,然后搜索"插入Roxygen骨架"。

标记@export指示当使用package::my_fun或在library(package)之后my_function将被导出为对用户可见。标记@import使ggplot2包中的所有导出函数都可供您使用,即当您在包中使用此包中的函数时,无需使用ggplot2::aes()。标签@importFrom仅使包中明确提到的功能可用,即不需要使用package::fun(),但对于该包中的其他功能是必要的。

您应该使用

#' @export

#' @importFrom 

最好是在文件(及以上(中使用这些导入的代码。参见Roxygen2上的Vignette,NAMESPACE标签然后,对devtools::document()的调用将通过这些注释生成适当的NAMESPACE等。

最新更新