r - 使用 devtools 构建 .md 插图

Question

我正在使用 knitr::rmarkdown (但 knitr::knitr 和我的 VignetteEngine 一样) .然后我使用 devtools::build_vignettes() 构建我的包小插图.

这有效，但仅在 inst/doc 中创建 HTML 和 R 输出文件.我想要的是一个 Markdown 输出文件，因为只有它可以直接显示在 Github 项目页面中(对于 HTML 文件，Github 显示源代码，对于 Rmd 文件，它显示渲染的输出，但 - 显然 - 不执行 R 块)。

我已经尝试找出如何为自定义 VignetteEngine 指定输出s，我认为这应该是可能的(毕竟，其他软件包至少使用它来构建 PDF 小插图)但我找不到通过 devtools::build_vignettes 执行此操作的方法.有没有办法手动构建小插图(即通过 knitr::knit 或忽略 VignetteBuilder 指令的类似机制)？

我也无法在文档/来源中找到相关信息。

Answer 1

小插图的唯一输出格式是 HTML 和 PDF(和 LaTeX，但它被转换为 PDF，不显示)。不支持 Markdown 。

您可以在包中包含任意文档文件(按照惯例，您将它们放在 inst/doc 中)，但它们不被视为小插图，因此它们不会自动构建，函数如 browseVignettes()会忽略它们，等等。

要将 Rmd 文件转换为 md，只需运行 knitr::knit在上面。