Roxygen认为我的函数是一种S3方法,因此在安装我的软件包时会中断

Question

我正在使用roxygen创建自己的包.我有一个导致问题的功能:

##' extract.sig.metadata
##' @param foo bar
##' @author me
##' @export
extract.sig.metadata <- function(foo){
# does stuff
}

我已经创建了我的包骨架(使用devtools的create(my-package)),并且我使用了document()来处理roxygen标签.但是,当我尝试安装我的软件包时,它会失败:

... *安装帮助索引**构建软件包索引**测试是否可以加载已安装的软件包错误:加载命名空间'my-package'时找不到对象'extract'错误:加载失败执行停止

我很确定roxygen认为extract.sig.metadata是一个S3方法,即一种特殊形式的export(),但它没有找到函数export(),所以它正在破坏.但这不是一个s3方法,它只是一个名为extract.sig.metadata的函数.如果我查看Rd代码,/ usage标记看起来很奇怪:

\usage{
\method{extract}{sig.metadata}(spec.df, var = "product_name",
  ratio.cutoff = 0.001, prob.modifer = 3, frequency.cutoff = NA,
  verbose = F, assign.to.global.env = FALSE, use.bigrams = T, clean = T,
  ngram.dupe.n.cutoff = 0.1, max.obs = 10000)
}

如果我确实将名称更改为extractSigMetadata,则问题在技术上已得到修复,并且.Rd代码会更改,

\usage{
 extractSigMetadata(foo)
}

但我真的不想改变我的函数的名称(我的包中有几十个函数有相同的问题,并且它们被用在一堆脚本中 - 改变我的命名将是一个巨大的痛苦架构不).

--->有谁知道我怎么能告诉roxygen这只是一个正常的函数而不是奇怪的s3方法？我猜它与@method标签有关,但我不知道如何正确使用它来使这项工作.谢谢!!!

Answer 1

固定它!

使用@export extract.sig.metadata而不是@export显然告诉roxygen extract.sig.metadata是整个函数名称,这解决了问题.在这种特殊情况下,我没有通用的提取函数,但R.utils(我的包不依赖但仍加载的包)确实有一个提取函数.

希望这有助于将来遇到同样问题的任何人.谢谢!

PS Hadley提出了更好的命名实践,我将在未来尝试这样做.