使用 rmarkdown 作为小插图引擎

Question

我在 R Markdown 中写了一些小插曲，目的是让它们 使用 RStudio 的 rmarkdown 构建 包裹。我知道rmarkdown::render是我们用来转换的函数 .rmd 到 .html（或任何其他格式），但是，当我放置

<!--
%\VignetteEnginer{rmarkdown::render}
%\VignetteIndexEntry{some test title}
-->

在我的 .rmd 的序言中（以及我的 Suggest 字段中的 knitr 和 rmarkdown 描述，以及 VignetteBuilder 字段中的rmarkdown）我的小插图 不编译。

有没有人设法让rmarkdown 充当小插图制作者？

Answer 1

取自@Ben 的回答（以及下面的 cmets），knitr 已注册了一个访问 rmarkdown 的小插图引擎（如果已安装）并且

<!--
%\VignetteEngine{knitr::rmarkdown}
%\VignetteIndexEntry{Supplementary materials}
-->

是我们如何注册它的示例。但是，为了充分利用rmarkdown（即将.Rmd 转换为.html 并保留.Rmd 中定义的任何样式），您必须将代码sn-p 放在上面BELOW“rmarkdown 序言”。例如，.Rmd 的顶部应该是这样的

---
Title: "Supplementary Materials"
output:
  html_document:
    theme: flatly
---
<!--
%\VignetteEngine{knitr::rmarkdown}
%\VignetteIndexEntry{Supplementary Materials}
-->

当然，您还需要确保已正确创建您的说明文件以包含rmarkdown 和knitr。最简单的方法是使用

Suggests: knitr, rmarkdown
VignetteBuilder: knitr

Answer 2

为什么要使用rmarkdown 而不是knitr？乍一看，您的问题在rmarkdown 和knitr 之间似乎有点混淆。澄清一下：

rmarkdown 是一种“基于 knitr 和 pandoc”的“创作格式”。当我们运行 rmarkdown::render 时，我们正在调用 knitr 和/或 pandoc。

knitr 是将 rmarkdown 转换为 html/PDF/docx 的引擎。这就是执行R 代码以获取输出和绘图等的内容。

knitr 包作者already mentioned 表示，“因为 rmarkdown 包还没有在 CRAN 上，所以你现在不能使用小插图引擎 knitr::rmarkdown”。如果你等不及可以register your own engine，但这看起来相当复杂。

我想你想要的是：

这在您的 Rmd 文档的顶部：

<!--
%\VignetteEngine{knitr::rmarkdown}
%\VignetteIndexEntry{Supplementary materials}
-->

这在你的DESCRIPTION 文件中：

VignetteBuilder: knitr
Suggests:
    knitr

如需完整示例，请查看tidyr package，这里是DESCRIPTION，这里是rmarkdown vignette（向Andrie 致敬，让我知道这一点）。

如果您想从rmarkdown 获得您无法从knitr 获得的特定内容（自定义样式等），那么您应该将其放在一个新问题中。