处理故意的命名空间冲突

Question

我正在编写一个导入（并使用）SparkR::sql 和 dbplyr::sql 的包。其他relevantquestions 涉及无意的碰撞，导致我随意的importing。

在我的NAMESPACE 我有：

importFrom(dbplyr, sql)
importFrom(SparkR, sql)

这两个函数都在脚本中使用，考虑到冲突，我肯定总是在包名前加上前缀：

dbplyr::sql(...)
SparkR::sql(...)

尽管如此，我在构建/检查包时收到了导入替换警告：

警告：加载“my_pkg”时，将之前的导入“dbplyr::sql”替换为“SparkR::sql”

我在Writing R Extensions 中看到的内容似乎如下：

如果一个包只需要另一个包中的几个对象，它可以在代码中使用完全限定的变量引用 [foo::f] 而不是正式导入...这比正式导入效率略低，而且也会丢失将所有依赖项记录在NAMESPACE 文件中的优点（但它们仍然需要记录在DESCRIPTION 文件中）。评估 foo::f 将导致包 foo 被加载，但如果尚未加载，则不会附加该包 - 这可能是延迟加载很少使用的包的优势。

我认为这个/最佳实践的要点是：

• 选择最常用的函数并将其添加到importFrom
• 从importFrom 中删除“不太频繁”的功能，但将该包保留在DESCRIPTION 中
• 只需使用::（可能前面有require()）作为“不太频繁”的功能

Answer 1

我一直关注this advice：

包在描述中的导入中列出是很常见的，但在命名空间中却没有。事实上，我建议这样做：在DESCRIPTION中列出软件包以便安装它，然后始终使用pkg::fun()显式引用它。

在你的情况下：

• 删除两者 importFrom
• 将两个包保存在Imports:
• 使用dbplyr::sql 和SparkR::sql

我在这里的主要动机是一致性：即使没有任何名称冲突，我也希望在阅读代码时始终使用全名以明确某些函数的来源。如果我不使用importForm 并忘记在一个地方使用全名，R CMD ckeck 会抓住这一点。我认为这种代码清晰度高于在两个地方收集依赖项的（感知的）优势：描述和（更明确的）命名空间。