在 RMD 中使用外部包作为 R package 的一部分

Question

语境

我正在使用带有多个 RMD 的 R package 来演示各种组件，即详细示例、理论等。 RMD 按照建议存储在inst文件实例中，并且我有将它们复制到用户工作目录中的功能他们可以与示例交互并从示例中导出内容。

问题

我希望这些 RMD 文件之一使用两个库，其中一个也用于 Roxygen2 示例（另一个没有）。 package 本身的功能不需要这两个库，但是：

1. 对于第一个 package，输入需要几个变量（我想展示），如果没有非常专业的 function 可以在不同的 ZEFE90A8E604A7C840E8ZF0 中找到，其中一个变量将很难计算。 I do not think it is within the scope of the package to implement this functionality (and if it were, it would just be a slightly-tuned alias of an external package function, which I do not think is good practice).

2. 对于第二个 package，它是boot package。 我只想展示一个使用我的 package 引导置信区间的示例。 这不是必需的，但很有用，因为涉及随机过程。

问题

将这些包包含在我的 RMD 文件中是一个很好的做法。 显然，对于 Roxygen2 示例中的那个，我需要它作为建议的 package，但另一个似乎在技术上不需要它。

我应该将它们列为建议的软件包吗？ 如果我这样做了，我应该在 RMD 文件中添加存在检查以确保用户拥有它们，还是应该让他们自己弄清楚？

提前致谢！

Answer 1

是的，将它们列为建议的包，并在使用它们之前检查它们是否使用requireNamespace安装。

我不确定您在哪里看到将 Rmd 文件放入inst的建议； 将它们构建为小插图可能更有意义，并将它们放在vignettes目录中。 这是放置此类文档的标准位置。

通常不需要将它们复制到工作目录中（这通常被认为是不好的做法，除非您只是在询问后才这样做，并且注意不要踩到用户自己的文件）。 您可以使用system.file("doc/something.Rmd", package = "yourPackage")从那里访问它们而无需复制。