将依赖项正确添加到 r 包中，以便它们自动安装

Question

我正在制作我的第一个 R 包，并且我正在尝试包含包依赖项。该软件包在我的机器上安装并运行良好，但我已经安装了所有依赖项。当其他用户尝试安装但他们尚未安装所有依赖项时，他们会收到错误消息。

ERROR: dependency 'dplyr' is not available for package 'my_package'

我正在通过

roxygen2

记录包裹。

我知道我应该在我的

#'@import

文件中包含

/R

行，并且它们会自动添加到

DESCRIPTION

和

NAMESPACE

文件中。

我的

DESCRIPTION

文件如下所示：

Package: my_package
Title: What the Package Does (one line, title case)
Version: 0.0.0.9000
Authors@R: person("First", "Last", email = "[email protected]", role = c("aut", "cre"))
Description: What the package does (one paragraph).
Depends: R (>= 3.4.1)
License: What license is it under?
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.0.1
Imports: dplyr,
    descr

我的

NAMESPACE

看起来像这样：

export(my_function)
import(descr)
import(dplyr)

用户正在本地安装软件包：

install.packages("C:/custom_packages/my_package_0.0.0.9000.tar.gz/", repos = NULL, type = "source")

我读过的关于这个主题的答案说，在

DESCRIPTION

和

NAMESPACE

中拥有正确的导入语句应该是记录依赖项所需的全部，我在这里有。我安装的大多数 CRAN 软件包的行为是，如果有未安装的依赖项，它会随安装一起安装。我缺少哪些步骤才能让我的包模仿这种行为？

Answer 1

根据我的经验，在开发第一个软件包时，一个好的策略是检查其他人的工作。最简单的方法是在 Github 上检查一些您最喜欢的软件包。例如，这是我的描述文件之一的一部分：

Depends: 
  R (>= 3.3.0)
License: GPL-3
Imports: 
  stringi (>= 1.1.7), 
  data.table (>= 1.10.4.3),
  methods (>= 3.3.0),
  quanteda (>= 1.1.0),
  scales (>= 0.5.0),
  stats (>= 3.3.0),
  utils (>= 3.3.0)

如您所见，每个包都有一个最小版本（其中大多数只是我使用的版本，但对于某些版本，我测试了旧版本是否有效）。我使用 Imports 来标记包，而 Depends 仅用于指示我成功测试的最旧的 R 版本。对于包，您几乎应该始终使用 Imports 或 Suggests 而不是 Depends。

完成设置后，您可以运行：

# This should point to the folder of your DESCRIPTION file    
setwd("/path/to/your/package/")  
roxygen2::roxygenise(clean = TRUE)

不要直接更改命名空间！这应该足以安装您的软件包或将其放在 GitHub 上。

但是，这只是冰山一角，最好查看这篇文章，然后阅读这本书中的详细信息。

更新：鉴于@Benjamin 的评论，我发现我错过了你问题的一部分。

repos = NULL, type = "source"

抑制依赖项的安装。更好的方法是使用

devtools

。我不确定这是否是正确的方法，但是当我已经有一个 tarball 并需要安装它时，我使用类似的东西：

# In Windows use copy and paste directly on the file to get a link  
devtools::install_url("C:/custom_packages/my_package_0.0.0.9000.tar.gz")

2024 年更新

自从我在 2018 年写这篇文章以来，已经有了一些进展。我现在从不定义最小版本，除非有人指出旧版本存在问题。我在这里追随更广泛的趋势，因为似乎没有人再这样做了。其次，我现在广泛使用

usethis

进行开发。对于这里的问题，函数

usethis::use_package()

可以为你完成一切。本章将引导您完成整个游戏：https://r-pkgs.org/whole-game.html