作为一个不怎么 Skr 的 API Wrapper，最近花式的用到了高德地图的地理编码/逆编码服务，与其散乱各处每次都要反复修改 function 代码，不如干脆就封装成 package，还能方便自己和团队今后的使用。
作为年轻人（并不）的第一个 Package，当然是参考 Hadley 的经典手册《R Package》，此外还参考了来自 Fong Chun Chan’s Blog 的 Making Your First R Package 作为快速手册。Functions 编写的过程非常的愉快，毕竟只是 url 与 reques body 的组装，在 httr, jsonlite 以及 XML2 等三个主要包的帮助下，API Wrap 只不过是体力活。目前包正在 CRAN 审核，如果上线了应该又能水一篇文章，不过没上线也应该会水一篇……记账上吧先。
然而，与写业务代码相比，提交包到 CRAN 没想到是最痛苦的。最主要的原因之一，就是作为一个 API 调用的包，几乎所有的操作都需要调用 token：
- 写 function，需要提供 key 参数（高德提供 token，官方文档称为 key，为了统一，一并称为 key，下同），这个很简单，单独赋值或者从
getOption('amap_key')中获取（此为 function 中的逻辑，非 R 缺省操作，下同）均可，无论是测试还实际业务都能轻松完成，也无需暴露 key； - 写 README，虽然不是 CRAN 强制要求的，但是作为肯定会在 GITHUB 开源的项目，README 必不可少，从 Rmarkdown 到 Markdown，因为是在本地编译，也可以从 Option 中获取，因此编译成的 Markdown 和原始 Rmarkdown 文件中均可隐去 key；
- 写单元测试，这个就开始有坑了。虽然
devtools::test可以通过测试，但是在devtools::check()中因为每次测试都是在独立的 NAMESPACE 中进行的，因此即便是设置了option(var1 = value1)，在测试中的getOption('var1')依然返回NULL，因此需要在测试中加入 key 的值，这就使得 token 会随着 package 的分发，对所有的用户可见； - 写 vignette，这个坑和单元测试情况相似，即便是 option 中加入了变量，依然不能保证可以正确编译，并且比较玄学的是某些情况下，可以从 option 中读取变量，但是在 R Studio 的 Build 页面中运行 check 又不可以获取，最终报错。而且即便是本地编译成功，如果不做任何额外的操作，发送到远端服务器后依然无法编译成功，原因也很简单对方的环境中毕竟没有 key 变量，因此需要在 vignette 相关部分加入 key 的值，再次会造成 key 的泄露。
虽然，作为免费的 token，大概有心盗用的人也不会太多，况且 package 有人用没人用还是很难乐观的议题。然而，信息泄露总归是不好的。
为了解决问题 3、4，花费了比写业务代码还久的时间，虽然有很大的概率不是最优，并且其实书里面有提到。但既然自己遇到了，并且 Stackoverflow 也有人提完，不如依然做个记录，万一能帮到同样没认真看书的朋友呢?
No vignette, No test, No Trouble?
最先想到的方法，当然是放弃。毕竟我们平日写 function，连注释都没有，写一个不怎么样的包，怎么还要写文档了呢?自己去悟不好么?
关于 vignette 和 test 的必要性，这里就不再做科普了，感兴趣的朋友可以参考《R Package》中的章节 Vignettes: long-form documentation 以及 Testing。然而其实书里面好像是没讲到的问题是，远程检查代码的过程中会回报一个 Warning：
诚然，Warning ~= Can’t be better，然而在 CRAN 提交的过程中，WARNING ~= ERROR
Check results: I always state that there were no errors or warnings. Any NOTEs go in a bulleted list. For each NOTE, I include the message from R CMD check and a brief description of why I think it’s OK. If there were no NOTEs, I’d say “There were no ERRORs, WARNINGs or NOTEs —— R Package: Chapter 20.3 The submission process”
虽然可以选择 Upload 到 CRAN，不过在 Review 步骤也很容易被返回。因此这种豁达的操作是行不通的。
skip_on_cran() for testthat
在 test 部分想要解决这个问题，其实可以在 test 起始部分加入 skip_on_cran() 方法（下列代码第二行）
# Test whether getAdmin can retrun right class withou to_tibble
test_that("Reuturn raw respone with correct location", {
skip_on_cran()
res <- getAdmin("四川省", to_table = F)
res_class <- class(res)
expect_equal(any(stringr::str_detect(res_class, "list")), TRUE)
})这个方法其实在 R Package: Chapter 12.5 CRAN notes 有提到：
Tests need to run relatively quickly - aim for under a minute. Place skip_on_cran() at the beginning of long-running tests that shouldn’t be run on CRAN - they’ll still be run locally, but not on CRAN.
不过一方面是因为看书不认真，另一方面只是注意到这方法 Hadley 的意图是加快测试时间，只在本地进行测试，因此忽略了这种无法在远端进行测试的场景。
不过添加这个方法后问题也不是全然解决，因为正如前面所说，devtools::check中的单元测试会在单独的 NAMESPACE 中进行，因此即便是在本地运行，如果不单独指定 key，检查过程依然会失败。因此我们用到了skip()family 的另外一种形式skip_if()来进行了条件判断:即只有满足 condition 的时候才会进行单元测试，在本案例中具体而言就是 option 不存在 amap_key 参数，则不进行测试：
skip_if(is.null(getOption("amap_key")))更多 skip 方法请参考help(testthat::skip)
no test 的 Warning 被解决，只不过因为 CRAN 会跳过测试步骤，处于保险起见，还是应该在本地进行更仔细的测试。
NOT_CRAN for vignette
Note: 这个部分，虽然解决了 Warning 警告，但实际上处理并不完美：无法在文档中预览变量，实际上只是显示了静态代码块。如果有更好的解决方案，还望不吝赐教
在 Hadley 为 httr 编写的 vignette Managing secrets 中对于如何处理保密的数据有了很充分的讨论。
Vignettes pose additional challenges when an API requires authentication, because you don’t want to bundle your own credentials with the package! However, you can take advantage of the fact that the vignette is built locally, and only checked by CRAN.
因为 Vignettes 是在本地进行编译的，因此我们可以指定仅仅使用 CRAN 进行检查工作（而非再次构建）。
只要在首次调用 token 的代码块之前添加代码块设定 knitr:opts_chunk$set，通常是 vignette 文字开始之前，文档的 YAML Header 结束之后。
NOT_CRAN <- identical(tolower(Sys.getenv("NOT_CRAN")), "true"),
knitr::opts_chunk$set(purl = NOT_CRAN)
之后在所有需要调用 Token 的代码块中，将 eval 设定为 eval = NOT_CRAN，之后在 CRAN 检查中 vignette 构建的步骤便不会报 ERROR。
图中有重复赋值，已修改
在该方法中，会对 R 运行环境进行检查，如果当前环境为 CRAN 则不运行 vignette 文档中的代码块，也正因为如此，Rmarkdown 中的代码块也就不会返回执行内容，因此文档中也不会显示结果，代码块仅做静态展示之用。
错误的挣扎
在第二张图中，可以发现在使用 NOT_CRAN 来解决 vignette 错误之前，我还常使用 source R script 的方法解决问题，当时的设想很完美：将 option(amap_key="My token")写入外部文件，之后将外部文件放入 .Rbuildignore 中在 package 打包的过程中排除掉，是否就能得到完美的解决方案了呢?
然而实际上，放入 .Rbuildignore 中的文件因为被排除在了打包之外，而构建 vignette 是完成打包之后方才进行，因此这种情况下是找不到文件地址的（因为没有在已经打包完成的library目录中）。
通过这些方法，目前暂时实现了 0 error 0 warning，各位处理过相似问题的前辈如果有更合理的解决方案，还望能分享指点。
欢迎通过邮箱，微博, Twitter以及知乎与我联系。也欢迎关注我的博客。如果能对我的 Github 感兴趣，就再欢迎不过啦！