ITADN
r-hub/rhub
r-hub/rhub · 文件 下载 ZIP
文件最后提交记录最后更新时间
README.md
以下内容由 AI 翻译,如有问题请点此提交 issue 反馈

rhub

R-hub v2

Lifecycle: experimental R-CMD-check Codecov test coverage

R-hub v2 使用 GitHub Actions 运行 R CMD check 及类似的包检查。 rhub 包可帮助您为 R 包设置 R-hub v2,并开始 运行检查。


安装

从 CRAN 安装 rhub:

pak::pkg_install("rhub")

用法

要求

  • 一个 GitHub 账户。
  • 你的 R 包必须位于一个 GitHub 仓库中。
  • 你需要一个 GitHub 个人访问 令牌。 你可以使用 gitcreds 包 将 令牌添加到 git 凭据存储中。

如果你的包不在 GitHub 上,请参阅 R Consortium runners 部分 以了解如何使用 rhub。

私有仓库

rhub 使用 GitHub Actions,这对于公共仓库是免费的。对于 私有仓库,你也会获得一些免费分钟数,具体取决于 你拥有的 GitHub 订阅。请参阅 关于 GitHub Actions 的计费 以获取详细信息。

设置

  1. 切换到你的包所在的目录,并调用 rhub::rhub_setup() 将 R-hub 工作流文件添加到你的包中。
rhub::rhub_setup()
  1. 运行 git commitgit push 将工作流文件推送到 GitHub。

  2. 运行 rhub::rhub_doctor() 检查是否一切设置 正确:

rhub::rhub_doctor()

运行检查

使用 rhub::rhub_platforms() 获取受支持的平台和 检查列表:

rhub::rhub_platforms()

运行 rhub::rhub_check() 以在 GitHub Actions 上启动 R-hub v2 检查:

rhub::rhub_check()

R Consortium 运行器

如果你不想将你的包放在 GitHub 上,你仍然可以使用 rhub 包,通过 https://github.com/r-hub2 GitHub 组织中的共享运行器池,在任何受支持的平台上运行包检查。

该过程与 R-hub 的第一个版本类似:

  • 将你的工作目录设置为你想要检查的 R 包。

  • 从 R-hub 获取一个令牌,以验证你的电子邮件地址:

    rc_new_token()
    

    (如果你之前已经从同一台机器使用相同的电子邮件地址向 R-hub 的 早期版本提交过包,则无需执行此操作。调用 rc_list_local_tokens() 以检查你是否已经拥有 令牌。)

  • 使用以下命令提交构建

    rc_submit()
    
  • 选择你要使用的平台,并按照提供的说明和 链接查看你的检查结果。

R Consortium 运行器的局限性

  • 你的包将对全世界公开,并将存储在 https://github.com/r-hub2 组织中。你的检查输出和 结果将对任何拥有 GitHub 账户的人公开。如果你想 保持你的包为私有,你可以将其放在一个私有的 GitHub 仓库中,并使用 rhub_setup()rhub_check() 函数 代替。
  • R Consortium 运行器在所有用户之间共享,因此你可能需要 等待你的构建开始。
  • 使用 rc_submit() 提交之间,你必须至少等待五分钟。
  • 目前,你需要创建一个 GitHub 账户才能查看 你包的检查日志。你不需要 GitHub 账户即可提交检查。

为避免这些限制(除了需要一个 GitHub 账户之外), 请将你的包放入一个 GitHub 仓库,并使用 rhub_setup()rhub_check() 函数,而不是 rc_submit() 和 R Consortium 运行器。

行为准则

请注意,rhub 包是附带 贡献者行为准则 发布的。 通过为该项目做出贡献,你同意遵守其条款。

许可证

MIT © R Consortium