R 包 API 示例答案

【问题标题】：R package API exampleR 包 API 示例
【发布时间】：2020-10-27 12:14:40
【问题描述】：

我目前正在修改 an R package 以适应 API 访问更改：API 现在需要个人的电子邮件地址和访问密钥才能工作。

因此，该软件包现在还需要一个电子邮件地址和访问密钥（前两个参数）。出于这个原因，the code examples provided for the functionacled.api() 不再通过通常的检查。是否有人知道一种方法可以使示例运行以进行检查，而无需对我自己的访问密钥进行硬编码（这当然不是一种选择）？

我目前的解决方案是“注释掉”函数示例，以便检查不会返回错误，但我可以想象这是不好的做法（或者可能违反某些 CRAN 政策）。示例代码：

    #' # my.data.frame1 <- acled.api(email.address = "your.email.address",
    #' #   access.key = "your.access.key",
    #' #   region = c(1,7),
    #' #   start.date = "2018-11-01",
    #' #   end.date = "2018-11-31")
    #' # head(my.data.frame1)

我一直在网上搜索有关此问题的信息，但无济于事 - 如果有人知道我错过的任何信息或 CRAN 政策，请告诉我。

祝你好运，克里斯

【问题讨论】：

标签： r api package cran

【解决方案1】：

这是在提出问题后立即得到答案的时候之一。对于有此问题但无法找到答案的其他人：

CRAN 实际上在2.1.1 Documenting functions 部分提供了有关示例的信息。从中可以看出，如果没有示例被常规检查“运行”，那是可以的。然而，与其注释掉这些例子，不如用\dontrun{}括起来。

希望这对也在搜索此信息的人有所帮助。

干杯，克里斯

【讨论】：