如何正确地搭建一个 R 包
何时使用: 你厌烦了手写 DESCRIPTION、NAMESPACE 和 roxygen2 样板代码。
步骤
-
搭建使用 Posit R-package skill。创建一个名为 'tidylaundry' 的新包,包含 2 个导出函数:wash() 和 fold()。✓ 已复制→ 包含 DESCRIPTION、NAMESPACE、R/、tests/testthat/、README 的目录
-
添加 roxygen为每个函数添加包含 @param、@return、@examples 的 roxygen2 文档。✓ 已复制→ 内联文档,devtools::document() 将其转换为 man/
-
冒烟测试编写 testthat 测试,覆盖正常路径和每个函数的一个边界情况。✓ 已复制→ devtools::test() 下的测试通过
结果: 一个能在第一天就通过 R CMD check 的包。
注意事项
- 生成的代码在应该用 tidyverse 更清晰的地方用了 base R(反之亦然) — 提前声明你的风格偏好