r - CMD检查错误

Question

我是第一次尝试创建一个包，但在使用 R CMD 检查时遇到了问题。

最初，我收到“注释”说我的全局变量没有可见的绑定(bind)。我在正在检查的文件顶部为这些变量添加了赋值，现在当示例运行时，我收到错误消息，提示我无法更改锁定绑定(bind)的值。由于我没有锁定绑定(bind)，我假设这是 R CMD 检查正在做的事情，但我一直找不到任何描述这意味着什么或如何修复它的文档。

这是一个具体的例子。我的 R 文件包含如下函数:

.ddg.init.tables <- function() {
    size <- 100
    ddg.proc.nodes <<- data.frame(ddg.type = character(size),
        ddg.num = numeric(size), ddg.name = character(size),
        ddg.value = character(size), stringsAsFactors=FALSE)
}

使用这样定义的函数，我会得到注释:

.ddg.init.tables: no visible binding for '<<-' assignment to 'ddg.proc.nodes'

为了解决这个问题，我在 .ddg.init.tables 的定义之上添加了:

ddg.proc.nodes <- NULL

注释消失了，但后来在检查示例时的 R CMD 检查过程中，同时运行示例中的行:

ddg.init()

我现在得到错误:

> ddg.init()
Error in .ddg.init.tables() : 
  cannot change value of locked binding for 'ddg.proc.nodes'
Calls: ddg.init -> .ddg.init.tables
Execution halted

如果我省略了初始化，我会得到提示，但示例会执行。

“锁定绑定(bind)”消息是什么意思，修复它的最佳方法是什么？

感谢您的帮助。

Answer 1

包中的符号(函数或变量)在包的所谓“ namespace ”中定义。粗略地说，当您的 R 包被“加载”时，R 会创建一个环境并使用包中定义的符号填充它。然后它“锁定”环境，这样你的包符号就不会被意外地重新定义(例如，这样用户就不会意外地改变你的一个函数的定义)。然后，R 可以选择将锁定的环境“附加”到 search() 路径，瞧，用户可以访问您的惊人功能。

锁定您的环境以保护您的功能免受用户意外更改的副作用是包代码本身无法更改符号定义。通常这是一件好事——您希望包代码始终如一地执行。

您的用例似乎是关于在“运行时”创建一个对象。在创建环境之后但在锁定之前执行此操作通常就足够了，这可以通过在你的包，或多或少传统上放在文件 zzz.R 中。然后，您将调用 ddg.init()，同时仍然可以写入 namespace 。

另一种情况是对象的结构由您编写的函数决定。在这种情况下，人们会创建一个 R 对象并将其直接包含在包中，在 R/sysdata.rda 或 data/文件夹中，通常使用“延迟加载”允许您的 R 引用对象中定义的符号代码就好像它们是在包中定义的一样。

第三种可能性是您需要在运行时创建对象，在交互式 session 期间，例如，记录用户执行功能时网络服务是否可用。为此，我们的想法是在您的 namespace 中创建一个环境

.cache <- new.env(parent=emptyenv())

并修改环境的内容

setIsUp <- function() {
    .cache[["isup"]] <- TRUE
}

虽然您不能更改 .cache 的值(因为它被锁定，例如，您不能将 .cache 从环境更改为列表或新环境)，但您可以修改环境的内容你已经分配了。