R 中的可变默认包值

Question

我正在为 R 开发一个包，我想设置一些包范围的默认值，并能够稍后修改它们。我知道这听起来像全局变量，因此很邪恶，但我需要它来控制分析和调试并设置后端（该包可以使用各种外部程序来完成其任务，我称它们为后端）。

对于调用堆栈中的所有函数，所有这三个设置应该同时更改。例如，如果我调用 mypackage::function1(profiling = T) 和 function1 调用 mypackage::function2 和 mypackage:: function3 我希望就该调用而言也能对这些进行分析。一种解决方案可能是做 mypackage::turn.on.profiling() 并让所有函数引用某个包变量，但它需要锁定环境和类似的东西。

另一个可能是动态作用域，通过 sys.frame 系列函数进行模拟（也就是说，一旦分析打开，它就会针对堆栈上该点以下的任何内容打开）。不要告诉我 R 中的分析不是这样工作的，因为这是一种不同类型的分析，构建在现有分析之上，但有所不同。

我毫不怀疑我可以以某种方式破解它，但我想知道 CRAN 中是否有一个规范的解决方案，或者至少有一些针对此类问题的先例，这样我就不会重新发明轮子。

Answer 1

您可以在 function1 的开头设置一个选项，并在末尾或通过 on.exit 取消设置。类似于：

function1 <- function() {
  op <- options()       # current state of options
  on.exit(options(op))  # restore when function exits
  print(getOption("mypackage.profiling"))
  options(mypackage.profiling=TRUE)  # turn on profiling
  print(getOption("mypackage.profiling"))
}
options(mypackage.profiling=FALSE)
function1()
# [1] FALSE
# [1] TRUE
getOption("mypackage.profiling")
# [1] FALSE

您还可以在包启动期间通过 .onLoad 设置选项

Answer 2

另一种简单的方法是将参数放入包中的环境对象中，并让类似 turn.on.profiling 的函数对其进行修改。

# Don't export this 
.profileOptions <- new.env(parent=emptyenv())
.profileOptions$enabled <- FALSE

# export this one
profilingEnabled <- function(flag = NA) {
    oldFlag <- .profileOptions$enabled
    if (!is.na(flag)) {
       .profileOptions$enabled = flag
    }
    oldFlag
}

# then use it
profilingEnabled() # returns TRUE or FALSE
profilingEnabled(TRUE) # enables profiling, returns previous state