我们如何在构建 R 包时设置常量变量

Question

我们正在为我们的服务（巴西的机器人顾问）构建一个R包，并且我们一直在向函数中的外部API发送请求。

由于这是我们第一次构建包，因此我们有一些问题。 :(

当我们使用我们的包来运行一些脚本时，我们将需要一些信息作为api_path, login, password。

我们如何将这些信息放在包装中？

这是一个真实的例子：

get_asset_daily <- function(asset_id) {
    api_path <- "https://api.verios.com.br"
    url <- paste0(api_path, "/assets/", asset_id, "/dailies?asc=d")
    data <- fromJSON(url)
    data
}

有时我们使用 API 的staging版本，我们必须不断切换路径。我们应该如何在函数中调用它？

我们应该设置一个全局环境变量，一个包环境变量，只是在我们的脚本或包配置文件中定义api_path吗？

我们如何做到这一点？

提前感谢您的帮助。

安娜

Answer 1

一种方法是使用 R 的选项接口。在 R 目录中创建一个文件zzz.r（这是此文件的习惯名称），其中包含以下内容：

.onLoad <- function(libname, pkgname) {
    options(api_path='...', username='name', password='pwd')
}

这将在将包加载到内存中时设置这些选项。