17

这个问题很简单。第一的：

  1. 是否可以在 CRAN 包中包含非 CRAN（或生物导体或 omega hat）包，并在示例中实际使用该包中的工具。
  2. 如果是，如何设置DESCRIPTION文件等以使其合法并通过 CRAN 检查？

具体来说，我在询问曾经是 CRAN 包的openNLPmodels.en 。它非常有用，并且希望包含其中的功能。我可以做一个工作而不是在示例中实际使用openNLPmodels.en或为其创建单元测试，并在使用函数时安装它（类似于性别包安装它需要的数据集的方式）但我会更喜欢一种允许我运行检查、文本、示例的方法。

这就是下载和安装openNLPmodels.en 的方式

install.packages(
    "http://datacube.wu.ac.at/src/contrib/openNLPmodels.en_1.5-1.tar.gz",  
    repos=NULL, 
    type="source"
)
4

3 回答 3

1

现有的答案很好，但没有详细解释整个过程，所以发布这个。

是否可以在 CRAN 包中包含非 CRAN（或生物导体或 omega hat）包，并在示例中实际使用该包中的工具。

对的，这是可能的。此类非 CRAN 的任何使用（包代码、示例、测试、小插曲）都必须像Suggests中的任何其他包一样进行转义，理想情况下使用

if (requireNamespace("non.cran.pkg", quietly=TRUE)) {
  non.cran.pkg::fun()
} else {
  cat("skipping functionality due to missing Suggested dependency")
}

如果是，如何设置说明文件等以使其合法并通过 CRAN 检查？

您需要使用Additional_repositories说明文件中的字段。该字段中提供的位置必须包含预期目录结构、PACKAGES适当目录中的文件，并且PACKAGES文件必须列出非 CRAN 包。

现在转到您的特定openNLPmodels.en包示例。根据您下载和安装此软件包的方式，将无法将其用作依赖项并传递给 CRAN。openNLPmodels.en必须以 R 存储库预期的结构发布。否则，您没有有效的位置可以放入Additional_repositories现场。

您可以做的是自己下载非 CRAN 包并将其发布到您的 R 存储库中，然后Additional_repositories在 CRAN 包中的字段中使用该位置。以下是如何执行此操作的示例：

dir.create("src/contrib", recursive=TRUE)
download.file("http://datacube.wu.ac.at/src/contrib/openNLPmodels.en_1.5-1.tar.gz", "src/contrib/openNLPmodels.en_1.5-1.tar.gz")
tools::write_PACKAGES("src/contrib")

我们只是将包源放在预期的目录src/contrib中，其余的由write_PACKAGES函数很好地处理。为确保正确创建存储库，您可以列出该存储库中可用的包：

available.packages(repos=file.path("file:/",getwd()))

它应该在那里列出您的非 CRAN 包。然后在 R 存储库中发布非 CRAN 包，您应该将存储库的位置放入Additional_repositoriesCRAN 包的字段中。在这种情况下，位置将是file.path("file:/",getwd())表达式返回的位置。

请注意，它使用本地计算机上的位置，您可能希望将其放到网上，以便任何检查您的 CRAN 包的机器都可以访问该 URL，包括对 CRAN 本身的检查。为此，只需将您的src目录移动到将在线托管的公共目录并使用该服务器的位置。

现在再次查看您的非 CRAN 包，我们可以看到它的 url 中有src/contrib，因此我们可以假设它已经存在适当的 R 存储库，我们不必创建和发布新的。因此，您的安装说明可能看起来像

install.packages(
  "openNLPmodels.en", 
  repos="http://datacube.wu.ac.at",
  type="source"
)

然后，您的 CRAN 软件包所需要做的就是使用可用的现有存储库

Additional_repositories http://datacube.wu.ac.at
于 2020-11-20T10:09:37.737 回答
0

有可能，但是！...

文件中有一个字段DESCRIPTION可供您使用：

Additional_repositories: http://ghrr.github.io/drat

但！

依赖于来自附加存储库的包中的功能的所有内容都必须是绝对可选的。

所以来自这个 repo 的包应该放在Suggests.

例子

我不能 100% 确定 BioConductor 和 OmegaHat 是否被认为是主流。

于 2019-06-21T19:40:09.770 回答
0

该usethis::use_dev_package功能解决了这个问题。

例如，运行这一行：

usethis::use_dev_package(package = "h3", type = "Imports", remote = "crazycapivara/h3-r")

将自动将以下行写入您的DESCRIPTION文件：

Imports: 
    h3 (>= 3.7.1)
Remotes:  
    crazycapivara/h3-r

请注意，因为 github 是 R 中最常用的非官方包分发，所以它是默认的。因此，请确保文件部分中github::的条目没有前缀。RemotesDESCRIPTION

于 2021-11-10T21:41:22.847 回答