如何使用vignette向R包添加任意内容？

Question

如果可以的话，如何使用 R 包小插图生成任意文件以包含在已安装的包中？

我今天一直在修改两个具体的用例和方法。

首先，我有一个 Excel 模板文件，我希望用 (Sweave) 小插图中派生的数据填充该文件，然后在包中提供此修改后的 Excel 文件（与模板一起）。按照约定，模板位于源码包的inst/extdata目录下；该插图包含一些代码，这些代码使用 system.file 读取此内容，然后将修改后的副本写回同一目录。然而，虽然 vignette（和包）使用 R CMD build 成功构建，但在 tarball 的 R CMD INSTALL 之后，已安装的 extdata 目录包不包含修改后的文件，仅包含模板。

第二个用例更通用，涉及 Makefile。我想将 .tex 文件中的小插图渲染为 PDF 和 HTML 格式。我想要使​​用 make4ht 创建的 HTML 版本，实际上是供另一个应用程序摄取的，而不是在包本身中使用；因此我不希望它们与 PDF 小插图一起放在 doc 目录中 - 让我们将它们放在 outputs 中。

目前我正在尝试使用 Makefile 来实现此目的。在源包的 vignettes 目录中，我有一个非常基本的 Makefile，如下所示：

all : foo.tex
    make4ht foo.tex
    mkdir ../outputs
    mv foo.html ../outputs
    texi2pdf foo.tex
    rm foo.tex

R CMD build 上的预期行为是：

1. 创建 vignette < 的 HTML 版本code>foo.html 和 make4ht
2. 在 R 包根目录下直接创建一个名为 outputs 的目录
3. 将 HTML 文件移到那里
4. 创建 PDF 插图 正确
5. 清理要避免的 .tex 文件关于重复的小插图条目的错误

然后，在生成的 tarball 的 R CMD INSTALL 上，我希望在已安装的包下找到一个目录 outputs，其中包含文件 foo.txt。 html.然而，事实并非如此——PDF 和源插图都在那里，但没有输出 的迹象。

据我所知，软件包被安装到临时目录中是为了构建小插图。我假设写入此临时位置的文件实际上都没有合并到最终包中，除了 vignettes/*.pdf 或 vignettes/*.html 之类的文件。因此，在这种情况下，让我重复我的问题：

是否可以使用小插图创建（任意）文件以包含在包中？

我知道所有这些都可以在包构建之前完成，将文件放在 inst 下的某个位置。但如果可能的话，我更愿意一步完成这一切；这些小插图记录了数据分析的各个方面，我想在最终的包中提供此分析的输出，因此这似乎是一个自然的工作流程。

Answer 1

我很确定你做不到，而且尝试也没有任何意义。用户应该可以运行小插图来复制您获得的结果，或者进行一些小的更改以查看它们的效果。用户不应期望这会更改包的内容。

如果您希望小插图为用户生成文件，则默认情况下它们应该位于临时目录中，因此它们不会对用户的文件系统进行永久更改。

我认为你最后一段中的方法是唯一可行的方法。您在构建包之前运行一些 Makefile，并且可能会运行 vignette 将文件安装到某个地方的 inst 中。实现此目的的一种方法是让您的小插图查看环境变量以找到放置文件的目的地。您的 Makefile 可以在处理小插图之前设置环境变量。但是，如果用户（或 R CMD 构建系统）在没有该环境变量的情况下运行您的 vignette，则文件将不会生成，或者将在运行结束时被删除。