R：如何在我的 package 中正确包含库

Question

我正在编写第一个 R-Package 并且想知道包含其他库的正确方法是什么，例如ggplot2 。 所以在我的package中有两个地方可以导入语句go。 DESCRIPTION文件和NAMESPACE ，后者需要在一些 roxagen 语句中包含 ggplot ，例如#'@import ggplot2 。

Actually I thought that is is enough to include ggplot2 inside DESCRIPTION, as I thought that loading my packages will also load or dependencies, however, when ggplot2 is not in the namespace it seems like I cannot use function, eg aes, ggplot without writing ggplot2::aes or ggplot2::gpplot 。 那么每个配置文件中的导入语句是什么，即DESCRIPTION和NAMESPACE？

Answer 1

所需的一个步骤是在您的DESCRIPTION文件中的Imports:下包含ggplot2 。 这可确保在安装 package 时安装 ggplot2。

然后，要在 package 中使用 ggplot2 中的函数，您需要告诉 R 在哪里寻找它们。 您可以通过 3 种方式做到这一点：

1. 使用时将 package 的名称放在 function 名称之前： ggplot2::aes() 。 这是我的首选方法，因为它不会在您的NAMESPACE中添加任何额外内容，避免任何名称冲突，并且在您以后返工或移除 function 时避免损坏。
2. 使用时导入特定功能。 通过将#' @importFrom ggplot2 aes放在使用它的 function 上方的 roxygen 块中来做到这一点。 将您需要的许多 function 名称添加到该行。 之后，您可以直接使用aes()而无需使用ggplot2::aes()指定它来自的命名空间。 如果您使用很多函数（例如使用 ggplot2），这可能会很方便，但我建议通常使用第一个选项来保持 NAMESPACE 更整洁。 对于任何 function，从技术上讲，您只需要在 package 中包含一次 @importFrom 行，但我建议将其包含在使用导入函数的每个 function 中。 这样，如果您返工或移除 function，其他功能不会中断。
3. 您可以通过将#' @import ggplot2放在 roxygen 块中来导入整个 package 函数。 这会从 package 导入每个 function。 这对于像 ggplot2 和 dplyr 这样的大包来说可能很多，并且可能会导致问题，所以我建议永远不要这样做，而只导入您需要的特定函数或使用ggplot2::aes()调用它们：

Answer 2

如果您依赖 package，您应该将其放在说明文件的Imports字段中，之后您可以在代码中使用pkgname::function() 。 usethis::use_package() function 可以帮助您做到这一点。

如果您希望您的代码能够在不使用::的情况下使用 package 的任何代码，您应该在以下位置添加 roxygen 注释：

#' @import pkgname
NULL

然后由 roxygen2 将其移植到您的 NAMESPACE 文件中。

如果您想专门使用某些功能（但不是其他功能），您可以使用 roxygen2 使用的以下功能：

#' @importFrom pkgname fun1 fun2
NULL

usethis::use_import_from() function 可以帮助您完成上述工作。 在上面的示例中， NULL仅表示您没有记录 function 或数据，您可以在文档注释块的末尾使用它。