首页 > 解决方案 > 如何在 Github 的 README 中添加 R-CMD-check 状态

问题描述

我知道如何在 R Studio 中进行 R-CMD-check 并通过了所有操作。

但是,我希望在 README 文件中为Github上的包添加这个 R-CMD 检查“通过”状态

就像下图所示。

我看到别人的这部分只是一个链接,当点击它时,它就变成了这张图片。

我想知道如何在 Github 上进行 R-CMD-check,以便在 README 中添加“通过”状态

在此处输入图像描述

标签: rgithubpackagereadme

解决方案


如果您想自动获得此徽章,请使用您的包打开 R 项目并运行:

usethis::use_github_action_check_standard()

在 R 控制台(或 RStudio)中。这会将.github/workflows/包含一些 YAML 内容的文件夹添加到您的包中。请参阅文档

当您提交并推送到 GitHub 时,检查应该会自动运行。如果要插入徽章,请转到 GitHub Web 界面中的“操作”菜单,打开检查结果,您将看到要插入到 README.md 中的徽章源代码(SVG 格式)文件。每次推送后都应该更新。

有关带有屏幕截图的完整且非常简单的手册,请访问https://ropenscilabs.github.io/actions_sandbox/packageci.html#actions-for-continuous-integration-checks


推荐阅读