2.14.0 即将到来的命名空间、依赖、导入更改（请一些定义/使用）

Question

如果您是软件包作者，那么当我们在大约一周后转向 2.14 时，您希望能够清楚地了解软件包结构即将发生的变化。其中一项更改是所有软件包都需要命名空间，如果您不创建命名空间，系统会为您生成一个命名空间（R 相当于您在美国的 Miranda 权利）。所以作为一个好公民，我试图解决这个问题。这是 R-exts 的部分：

1.6.5 总结 – 转换现有包

总而言之，将现有包转换为使用命名空间 涉及几个简单的步骤：

确定公共定义并将其放入导出指令中。 识别S3风格的方法定义并编写相应的S3方法 声明。识别依赖关系并替换任何 require 调用 导入指令（并在 Depends 和 导入描述文件的字段）。替换.First.lib函数 使用 .onLoad 函数或 useDynLib 指令。

为了确保我在这里做正确的事情，有人可以给出一个简短明确的定义/答案（我是否因为将几个小但相关的问题放在一起而违反了规则？）。所有答案都应考虑 2.14，请：

1. R 使用的 NAMESPACE 的定义
2. 有没有办法在构建和检查之前生成 NAMESPACE，或者我们 b/c 一次，然后编辑自动创建的 NAMESPACE？
3. 描述文件中“取决于：”和“导入：”之间的区别。特别是，为什么我要把包放在“Depends：”而不是“Imports：”中，反之亦然？
4. 听起来“require”不再被使用，尽管它没有这么说。这是正确的解释吗？

谢谢！

Answer 1

我在 https://github.com/hadley/devtools/wiki 上写了一些关于这个主题的文章/命名空间。

回答您的问题：

1. 请参阅德克的回答。
2. 使用 roxygen2
3. 既然每个包都有一个命名空间，那么就没有理由使用 Depends 了。
4. require 只能用于加载建议的包

Answer 2

CRAN 包几乎自古就有命名空间。只需选择一些您最喜欢的 CRAN 软件包并查看它们的 NAMESPACE 文件即可。

它可以像摘自 snow 的一行字（加上注释）一样简单

# Export all names unless they start with a dot
exportPattern("^[^.]")

：像往常一样运行 R CMD check ，在大多数情况下应该没问题。

Answer 3

我将用我在将几个软件包切换到 R 2.14 后学到的一些细节来回答我自己的问题。

手册中的上述描述给人的印象是，R 2.13 的 Depends: 中的任何内容都应移至 R 2.14 中的 Imports: 中。您应该这样做，但它们在功能上并不是一对一的相同，我希望从下面的注释中可以清楚地看出这一点。

我们开始吧：

Depends：可能应该仅用于版本限制，例如“R >= 2.10”或“MASS >” 0.1'，R 2.14 下没有其他内容。

拥有命名空间在一定程度上是一种通知用户可能存在名称冲突和“替换”的机制——换句话说，覆盖正在使用的名称。命名空间文件必须与描述中的项目和导入：字段匹配。导入的函数名称等将列在 sessionInfo() 中的“通过命名空间加载（且未附加）”下。这些包已安装但未加载（即没有库（某些导入的包））。

命名空间的另一个作用是让函数在你的包“内部”可用。我的意思是，如果您的包使用导入包中的函数，就会找到它。

但是，当您在检查期间要运行 .Rd 文件中的示例时，以前在 R 2.13 中的 Depends: 下但现在在 R 2.14 下的 Imports: 下的包不可用。这是因为检查环境非常类似于在干净的环境中获取脚本（假设您使用的是 R --vanilla，因此 .Rprofiles 等尚未运行）。除非您在示例中添加库（需要的包）语句，否则即使在 R 2.13 下工作，它也不会在 R 2.14 下工作。因此，即使您的包 Imports: 是所需的包，旧示例也不一定会运行，因为 Imports: 与 Depends: 并不完全相同（严格来说，它们是附加的但未加载）。

如果其中有任何错误，请纠正我。非常感谢 Hadley Wickham 和其他帮助我的人！

Answer 4

我最近为我的一个包做了这个工作。这是我的新 Depends、Imports 和 Suggests 行

Depends: R (>= 2.15.0)
Imports: nlme, mvtnorm, KFAS (>= 0.9.11), stats, utils, graphics
Suggests: Hmisc, maps, xtable, stringr

stats、utils 和图形是基本 R 的一部分，但用户可以分离它们，然后我的包将无法工作。如果您从命令行使用 R，您可能会想“为什么有人要分离这些？”。但是，如果用户正在使用 RStudio，我可以看到他们浏览并“取消单击”所有包。然而，奇怪的是，如果他们这样做，我不希望我的包裹停止工作。或者他们可能会重新定义绘图函数（或其他一些函数），然后我的包就会失败。

然后，我的命名空间包含以下几行，

import(KFAS)
import(stats)
import(utils)
import(graphics)

我不想浏览并跟踪我使用的统计信息、实用程序和图形函数，因此我导入了它们的整个命名空间。对于 KFAS，我只需要 2 个函数，但导出的函数名称在版本之间发生了变化，因此我导入整个命名空间，然后在我的代码中测试用户拥有哪个版本。

对于 mvtnorm 和 nlme，我只使用一个函数，因此我只导入这些函数。我可以导入整个命名空间，但尝试只导入我真正使用的内容。

importFrom(mvtnorm, rmvnorm)
importFrom(nlme, fdHess)

建议包出现的小插图

require(package)

中有线条。

对于我的命名空间中的导出函数，我有点困惑。 CRAN 已经变得严格，不允许 ::: 出现在你的包代码中。这意味着如果我不导出函数，我就会限制创意的重复使用。另一方面，我理解需要仅导出您打算使用稳定的参数列表和输出来维护的函数，否则我们会通过更改函数接口来破坏彼此的包。