时间戳

首页 > 解决方案 > R 包 API 示例

r - R 包 API 示例

问题描述

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

因此，该软件包现在还需要一个电子邮件地址和访问密钥（前两个参数）。因此，为该函数提供的代码示例 acled.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 政策，请告诉我。

干杯和最良好的祝愿，克里斯

标签： rapipackagecran

解决方案

这是在提出问题后答案就在拐角处出现的时候之一。对于其他有此问题但无法找到答案的人：

CRAN 实际上在第2.1.1 节记录功能中提供了有关示例的信息。从中可以看出，如果没有示例通过常规检查“运行”，则可以。然而，与其注释掉这些例子，不如用 . 括起来\dontrun{}。

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

干杯，克里斯

推荐阅读