首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >用roxygen2导出函数列表

用roxygen2导出函数列表
EN

Stack Overflow用户
提问于 2016-10-07 12:53:48
回答 1查看 1.1K关注 0票数 5

Problem -我想导出一个函数列表作为R包的一部分,最好使用roxygen2。

更准确地说,我希望导出列表中的函数,而不是列表本身。例如,考虑以闭包形式生成的函数列表,如下所示:

代码语言:javascript
复制
addval <- 1:100
fns <- lapply(addval, function(y) {force(y); function(x) x + y})
names(fns) <- paste0("add_", addval)

然后,问题是将函数(例如,在fns中使用相同的名称)绑定到包环境中,然后将它们包含在包的导出函数中。

可以很容易地将函数绑定到包环境;一种方法是

代码语言:javascript
复制
for (nm in names(fns)) assign(nm, fns[[nm]])

但是,是否可以使用roxygen2标记导出add_1__、add_2__等函数?

更重要的是:我希望roxygen2继续为我管理NAMESPACE文件,并且不希望直接编写export()调用。我看到这样做的唯一方法是编写代码来生成样板,如

代码语言:javascript
复制
#' @export add_1
NULL

#' @export add_2
NULL

# ...

或者更好

代码语言:javascript
复制
#' @export
add_1 <- fns[["add_1"]]

#' @export
add_2 <- fns[["add_2"]]

# ...

(并放弃上面的for-循环)。

roxygen2是否已经有一个类似于样板生产的设备,或者我必须自己提供这个设备?

我认为这样一种便利的表达方式更为简洁。

代码语言:javascript
复制
#' @exportObjects names(fns)
NULL

其中,标记@exportObjects将其“参数”解释为要导出的对象名称的字符向量。

更新

roxygen2 6.0.1+通过一个新的@evalNamespace标记解决了这个问题,它允许您在命名空间文件中插入文字条目:

代码语言:javascript
复制
ns_export <- function(nms)
  sprintf("export(%s)", paste(nms, collapse = ","))

#' @evalNamespace ns_export(names(fns))

使用标记@evalNamespace比使用exportPattern()指令更安全,因为在使用后者时,必须警惕不小心在与regex匹配的包命名空间中命名对象。

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2016-10-16 21:30:46

可以在最近的@rawNamespace中使用roxygen2标记,这允许在NAMESPACE文件(包括exportPattern() )中使用有效的任意语法。

代码语言:javascript
复制
#' @rawNamespace exportPattern("^add_.*$")
票数 3
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/39917807

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档