胡布

R-轮毂v2

R-hub v2使用GitHub操作运行R CMD检查和类似的包检查。rhub包帮助您为R包设置R-hub v2，并开始运行检查。

安装

从CRAN安装rhub：

巴基斯坦::pkg安装(“罗布”)

用法

要求

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

请参阅R联合体跑步者如果您的包不在GitHub上，请使用rhub。

专用存储库

rhub使用GitHub Actions，这对公共存储库是免费的。对于私有存储库，您还可以获得几分钟的免费时间，具体取决于您拥有的GitHub订阅。请参见关于GitHub操作的计费了解详细信息。

安装程序

  1. 切换到包的目录，然后调用rhub:：rhub_setup（）将R-hub工作流文件添加到包中。
罗布::rhub_设置()
#>设置R-hub v2。#>✔在找到R包/tmp/cli公司.                                                  #>✔在找到git存储库/tmp/cli文件.                                             #>✔已创建工作流文件/tmp/cli/.github/workflows/rhub.yaml.                   #>                                                                                 #>备注：#>•必须将工作流文件添加到违约GitHub的分支#>存储库。#>•必须为存储库启用GitHub操作。他们因以下原因被禁用#>默认情况下为分叉存储库。#>                                                                                 #>接下来的步骤：#>•使用“git Add<filename>”将工作流文件添加到git。#>•使用“git Commit”将其提交给git。#>•使用“git Push”将提交推送到GitHub。#>•调用`rhub:：rhub_doctor（）`检查您是否正确设置了R-hub。#>•致电`rhub:：rhub_check（）`检查您的包裹。

  1. 运行git提交和git推送将工作流文件推送到GitHub。

  2. 运行rhub:：rhub_doctor（）检查所有设置是否正确：

罗布::流变仪()
#>✔在找到R包/tmp/cli公司。#>✔在找到git存储库/tmp/cli公司.                                             #>✔找到GitHub PAT。#>✔在GitHub上找到存储库<https://github.com/r-lib/cli>.                 #>✖您的GitHub PAT有正确的范围吗？#>错误:                                                                          #>!无法使用PAT向GitHub进行身份验证#>ℹ确保URL和PAT正确无误。#>类型。Last.error查看更多详细信息。

运行检查

使用rhub:：rhub_platforms（）要获取支持的平台和检查的列表，请执行以下操作：

罗布::rhub_平台()
#>——虚拟机─────────────────────────────────────────────────────────── #>1[虚拟机]linux操作系统#>GitHub Actions ubuntu-latest上的所有R版本#>2[虚拟机]macos公司#>GitHub Actions macos-latest上的所有R版本#>3[虚拟机]macos-arm64电脑#>GitHub Actions macos-14上的所有R版本#>4[虚拟机]窗户#>GitHub操作窗口上的所有R版本-最新#>                                                                                 #>——容器───────────────────────────────────────────────────────────────── #>5【CT】地图集[阿特拉斯]#>R Fedora Linux 38上的开发中（不稳定）（2024-04-10 r86396）（Conta…#>ghcr.io/r-hub/containers/atlas：最新#>6【CT】铿锵鸡[asan，clang asan，clang UBSAN，UBSAN]#>Ubuntu 22.04.4 LTS上的R开发中（不稳定）（2024-04-10 r86396）#>ghcr.io/r-hub/containers/clang-asan：最新#>7【CT】叮当声16[叮当声16]#>Ubuntu 22.04.4 LTS上的R开发中（不稳定）（2024-04-09 r86391）#>ghcr.io/r-hub/containers/clang16：最新#>8【CT】叮当声17[叮当声17]#>Ubuntu 22.04.4 LTS上的R开发中（不稳定）（2024-04-09 r86391）#>ghcr.io/r-hub/containers/clang17：最新#>9【CT】叮当声18[叮当声18]#>R在Ubuntu 22.04.4 LTS上开发中（不稳定）（2024-04-09 r86391）#>ghcr.io/r-hub/containers/clang18：最新#>10【CT】牙医[唐纳特]#>Ubuntu 22.04.4 LTS上的R开发中（不稳定）（2024-04-09 r86391）#>ghcr.io/r-hub/contensions/donttest:最新#>11【CT】通用条款13[通用条款13]#>R Fedora Linux 38上的开发中（不稳定）（2024-04-10 r86396）（Conta…#>ghcr.io/r-hub/containers/gcc13：最新#>12【CT】英特尔[英特尔]#>R Fedora Linux 38上的开发中（不稳定）（2024-04-10 r86396）（Conta…#>ghcr.io/r-hub/containers/intel：最新#>13【CT】mkl公司【MKL】#>R Fedora Linux 38上的开发中（不稳定）（2024-04-10 r86396）（Conta…#>ghcr.io/r-hub/containers/mkl：最新#>14【CT】诺尔德[无]#>Ubuntu 22.04.4 LTS上的R开发中（不稳定）（2024-04-10 r86396）#>ghcr.io/r-hub/containers/nold：最新#>15【CT】建议[无建议]#>R Fedora Linux 38上的开发中（不稳定）（2024-04-10 r86396）（Conta…#>ghcr.io/r-hub/containers/nos建议：最新#>16【CT】乌班图-克朗[r-devel-linux-x86_64-debian-clang]#>R在Ubuntu 22.04.4 LTS上开发中（不稳定）（2024-04-10 r86396）#>ghcr.io/r-hub/containers/ubuntu-clang：最新#>17【CT】ubuntu-gcc12[r-devel-linux-x86_64-debian-gcc]#>Ubuntu 22.04.4 LTS上的R开发中（不稳定）（2024-04-10 r86396）#>ghcr.io/r-hub/containers/ubuntu-gcc12：最新#>18【CT】ubuntu-next公司[r-next，r-patched，r-patchid-linux-x86_64]#>Ubuntu 22.04.4 LTS上的R版本4.4.0 beta（2024-04-09 r86391）#>ghcr.io/r-hub/containers/ubuntu-next：最新#>19【CT】ubuntu释放[r-release，r-release-linux-x86_64，ubuntu]#>Ubuntu 22.04.4 LTS上的R版本4.3.3（2024-02-29）#>ghcr.io/r-hub/containers/ubuntu版本：最新#>20【CT】瓦尔格林[瓦尔格林德]#>R Fedora Linux 38上的开发中（不稳定）（2024-04-10 r86396）（Conta…#>ghcr.io/r-hub/containers/valgrind：最新

运行rhub:：rhub_check（）要在GitHub操作上启动R-hub v2检查：

罗布::rhub_检查()
#>✔在找到git存储库/tmp/cli公司。#>✔找到GitHub PAT。#>                                                                                 #>可用平台（有关详细信息，请参见“rhub:：rhub_platforms（）”）：#>                                                                                 #>1[虚拟机]linux操作系统GitHub上的R-*（任何版本）ubuntu-latest#>2[虚拟机]macos公司GitHub上的R-*（任何版本）macos-latest#>3[虚拟机]macos-arm64电脑GitHub上的R-*（任何版本）macos-14#>4[虚拟机]窗户R-*（任何版本）窗口-GitHu上的最新版本#>5【CT】地图集R-devel（2024-04-10 r86396）Fedora Linux 38（Contai…#>6【CT】铿锵鸡R-devel（2024-04-10 r86396）Ubuntu 22.04.4 LTS#>7【CT】叮当声16R-devel（2024-04-09 r86391）Ubuntu 22.04.4 LTS#>8【CT】叮当声17R-devel（2024-04-09 r86391）Ubuntu 22.04.4 LTS#>9【CT】叮当声18R-devel（2024-04-09 r86391）Ubuntu 22.04.4 LTS#>10克拉牙医R-devel（2024-04-09 r86391）Ubuntu 22.04.4 LTS#>11【CT】通用条款13R-devel（2024-04-10 r86396）Fedora Linux 38（Contai…#>12【CT】英特尔R-devel（2024-04-10 r86396）Fedora Linux 38（Contai…#>13[立方英尺]mkl公司R-devel（2024-04-10 r86396）Fedora Linux 38（Contai…#>14【CT】诺尔德R-devel（2024-04-10 r86396）Ubuntu 22.04.4 LTS#>15【CT】不建议R-devel（2024-04-10 r86396）Fedora Linux 38（Contai…#>16【CT】乌班图-克朗R-devel（2024-04-10 r86396）Ubuntu 22.04.4 LTS#>17【CT】ubuntu-gcc12R-devel（2024-04-10 r86396）Ubuntu 22.04.4 LTS#>18【CT】ubuntu-next公司R-4.4.0测试版（2024-04-09 r86391）Ubuntu 22.04.4 LTS#>19【CT】ubuntu释放R-4.3.3（2024-02-29）Ubuntu 22.04.4 LTS#>20【CT】瓦尔格林R-devel（2024-04-10 r86396）Fedora Linux 38（Contai…#>                                                                                 #>选择（逗号分隔的数字，0表示取消）：1，5#>                                                                                 #>✔检查已开始：linux、atlas（不负责挂钩）。#>请参见<https://github.com/r-lib/cli/actions（网址：https://github.com/r-lib/cli/actions）>用于实时输出！

R联盟运营商

如果您不想将包放在GitHub上，您仍然可以使用rhub包在任何支持的平台上运行包检查，该平台使用https://github.com/r-hub2GitHub组织。

该过程与R-hub的第一版类似：

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

  • 从R-hub获取令牌，以验证您的电子邮件地址：

    rc_new_token公司（）

    （如果您已经使用相同的电子邮件地址从同一台计算机向R-hub的早期版本提交了包，则无需执行此操作。请致电rc_list_local_tokens（）检查您是否已经拥有令牌。）

  • 使用提交生成

    rc_提交（）

  • 选择要使用的平台，然后按照说明和提供的链接查看检查结果。

R联盟运营商的局限性

  • 您的包将向全世界公开，并将存储在https://github.com/r-hub2组织。您的检查输出和结果将向拥有GitHub帐户的任何人公开。如果您想保持包的私有性，可以将其放在私有GitHub存储库中，并使用rhub_setup（）和rhub_check（）而不是函数。
  • R Consortium跑步者在所有用户之间共享，因此您可能需要等待构建开始。
  • 在提交与rc_提交（）。
  • 目前，您需要创建GitHub帐户来查看包的检查日志。您不需要GitHub帐户来提交支票。

为了避免这些限制（GitHub帐户所需的除外），请将包放在GitHub存储库中，并使用rhub_setup（）和rhub_check（）函数，而不是rc_提交（）和R财团运营商。

行为准则

请注意，rhub包发布时带有贡献者行为准则。通过参与此项目，您同意遵守其条款。

许可证

MIT©R联盟