使用 roxygen2 导入两个同名函数

Question

我是 CRAN 包的维护者，加载时收到以下消息：

* checking whether package ‘qdap’ can be installed ... [10s/10s] WARNING
Found the following significant warnings:
  Warning: replacing previous import ‘annotate’ when loading ‘NLP’
  Warning: replacing previous import ‘rescale’ when loading ‘scales’

因为我使用 plotrix 和 scales 包以及 NLP 和 ggplot 包。 它们具有共同的rescale和annotate功能。 这会导致最新的 CRAN 检查出现严重警告。 所以我决定“修复”它。

我做了这样的描述：

Package: qdap
Type: Package
Title: Bridging the gap between qualitative data and quantitative analysis
Version: 1.0.0
Date: 2013-06-26
Author: Tyler Rinker
Maintainer: Tyler Rinker <tyler.rinker@gmail.com>
Depends:
    R (>= 3.0.0),
    ggplot2 (>= 0.9.3.1),
    gdata,
    grid,
Imports:
    NLP,
    openNLP,
    plotrix,
    scales,
LazyData: TRUE
Description: Stuff
License: GPL-2

并将其添加到一些 .R 文件中：

#' @import ggplot2 gridExtra RColorBrewer
#' @importFrom scales alpha

但这会导致另一个警告：

* installing *source* package 'qdap' ...
** R
** data
*** moving datasets to lazyload DB
** inst
** preparing package for lazy loading
Warning: replacing previous import 'rescale' when loading 'scales'
Warning: replacing previous import 'annotate' when loading 'NLP'
Warning: replacing previous import 'alpha' when loading 'scales'

如何正确使用roxygen2的importFrom标签？

我已阅读： https : //github.com/hadley/devtools/wiki/Namespaces

但是我从一个必须这样做的例子中学到了最好的东西。 我不确定如何正确格式化描述文件以及使用roxygen2标签来避免：

* checking whether package ‘qdap’ can be installed ... [10s/10s] WARNING
Found the following significant warnings:
  Warning: replacing previous import ‘annotate’ when loading ‘NLP’
  Warning: replacing previous import ‘rescale’ when loading ‘scales’

这是qdap GitHub Repo

Answer 1

要记住的一点是，在包的命名空间中不能有多个同名的函数。

假设有两个包 pkgA 和 pkgB，它们都导出一个名为 foo 的函数。 如果您创建了一个包 pkgC，它在 NAMESPACE 中具有import(pkgA)和import(pkgB) 。 现在，当您调用library(pkgC)您会收到警告：

replacing previous import 'foo' when loading 'pkgB'. 

现在，假设有人创建了另一个包 pkgD，它在 NAMESPACE 文件中有这个：

import(pkgA)
import(pkgB)
import(pkgC)

然后， library(pkgD ) 将给出 2 个警告：

1: replacing previous import ‘foo’ when loading ‘pkgB’ 
2: replacing previous import ‘foo’ when loading ‘pkgB’ 

如果每个人都采用导入整个命名空间的做法，那么从现在起 30 年，这样的警告会很多。

相反，由于您的包中只能有一个“foo”，因此您应该明确导入您希望包使用的“foo”（和其他函数）。 在上面的例子中，pkgD 的 NAMESPACE 应该是

importFrom(pkgB,foo)

如果您确实需要从两个不同的包中使用具有相同名称的两个函数，您可以执行的一种技巧是从每个包中导入其他函数以确保安装了这些包并加载了它们的命名空间，然后参考您的函数需要使用::表示法，将它放在您的 NAMESPACE 中：

importFrom(pkgA,foo)
importFrom(pkgB,bar)

然后在代码中调用函数pkgA::abc()和pkgB::abc() 。

Answer 2

很可能不再对您有用，但对其他人可能不再有用：您的问题的答案可以在您提到的网站中找到，特别是在这里（引自来源）：“无论您使用@importFrom foo bar 多少次” .

所以roxygen2的标签@importFrom的正确使用是： @importFrom package_name function_name 。 没有逗号，括号，什么都没有，只有两个名字用空格隔开（很明显，可能适用于 1 个以上的函数）。

我刚刚在为我的一个软件包的新版本生成文档时自己尝试过这个，所以它应该可以工作。

我希望它有帮助。

Answer 3

最近我找到了解决这个问题的新方法。 我想在开发中导入 dplyr 以及 data.table，它会给出这些警告。 为了删除重叠函数，我使用 importFrom 导入 data.table 中除重叠之外的每个函数。

ls("package:data.table") %>% 
  setdiff(c("last","first","between",":=")) %>% 
  str_c(collapse = " ")

## "%between% %chin% %flike% %ilike% %inrange% %like% address alloc.col as.data.table as.Date.IDate as.IDate as.ITime as.xts.data.table chgroup chmatch chorder CJ copy cube data.table dcast dcast.data.table fcoalesce fifelse fintersect foverlaps frank frankv fread frollapply frollmean frollsum fsetdiff fsetequal fsort funion fwrite getDTthreads getNumericRounding groupingsets haskey hour IDateTime indices inrange is.data.table isoweek key key<- key2 like mday melt melt.data.table merge.data.table minute month nafill quarter rbindlist rleid rleidv rollup rowid rowidv second set set2key set2keyv setalloccol setattr setcolorder setDF setDT setDTthreads setindex setindexv setkey setkeyv setnafill setnames setNumericRounding setorder setorderv shift shouldPrint SJ tables test.data.table timetaken transpose truelength tstrsplit uniqueN update.dev.pkg wday week yday year"

setdiff 已包含所有冲突的函数名称。 最后我 importFrom data.table 只有上面的函数。