使用 `devtools::build_vignette` 编译小插图，以便 .md 保存在小插图目录中

Question

我正在尝试编译一个包 vignette，以便 .md 文件保留在 vignette 文件夹中，以便它在 github 上仍然可见。我正在使用 devtools 所有这些。我已经看过这个 approach 并将在下面概述它：

我已经使用 devtools::use_vignette() 自动生成了一个插图模板。然后我将 .Rmd 文件修改为如下所示（截断的模板版本）：

---
  title: "package"
author: "author"
date: "`r Sys.Date()`"
output:
  rmarkdown::html_vignette:
  toc: true
  keep_md: true
vignette: >
  %\VignetteIndexEntry{Vignette Title}
%\VignetteEngine{knitr::rmarkdown}
%\VignetteEncoding{UTF-8}
---

  Vignettes are long form documentation commonly included in packages. Because they are part of the distribution of the package, they need to be as compact as possible. The `html_vignette` output type provides a custom style sheet (and tweaks some options) to ensure that the resulting html is as small as possible. The `html_vignette` format:

  - Never uses retina figures
- Has a smaller default figure size
- Uses a custom CSS stylesheet instead of the default Twitter Bootstrap style

## Vignette Info

Note the various macros within the `vignette` section of the metadata block above. These are required in order to instruct R how to build the vignette. Note that you should change the `title` field and the `\VignetteIndexEntry` to match the title of your vignette.

所以 .yaml 被修改了，但是当我使用 devtools::build_vignettes() 编译时，它似乎没有在 vignettes 目录中留下 .md 文件。没有错误消息，小插图构建良好，所以这有点令人困惑。

总结一下这个问题，有谁知道如何使用 devtools::build_vignette 编译小插图，以便将基本的 markdown 文件保存在小插图目录中？

Answer 1

如果您对 build_vignette() 以外的功能持开放态度，那么这很容易，因为在一天结束时，一切只是外部的包装器pandoc二进制。

/tmp/vig> ls -l     ## start with nothing but Rmd
total 4
-rw-r--r-- 1 user grp 1015 Aug 10 14:21 soVig.Rmd
/tmp/vig> 
/tmp/vig> Rscript -e 'rmarkdown::render("soVig.Rmd", clean=FALSE)'


processing file: soVig.Rmd
  |.................................................................| 100%
   inline R code fragments


output file: soVig.knit.md

/usr/bin/pandoc +RTS -K512m -RTS soVig.utf8.md --to html --from markdown+autolink_bare_uris+ascii_identifiers+tex_math_single_backslash --output soVig.html --smart --email-obfuscation none --self-contained --standalone --section-divs --template /usr/local/lib/R/site-library/rmarkdown/rmd/h/default.html --highlight-style pygments --css /usr/local/lib/R/site-library/rmarkdown/rmarkdown/templates/html_vignette/resources/vignette.css --mathjax --variable 'mathjax-url:https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML' 

Output created: soVig.html
/tmp/vig> ls -l soVig.*
-rw-r--r-- 1 user grp 7066 Aug 10 14:24 soVig.html
-rw-r--r-- 1 user grp 1011 Aug 10 14:24 soVig.knit.md
-rw-r--r-- 1 user grp 1015 Aug 10 14:21 soVig.Rmd
-rw-r--r-- 1 user grp 1011 Aug 10 14:24 soVig.utf8.md
/tmp/vig>

因此，只需告诉 render() 不要清理，我们就可以保留降价源。

使用 `devtools::build_vignette` 编译小插图，以便 .md 保存在小插图目录中

Compile a vignette using `devtools::build_vignette` so that .md is kept in the vignettes directory

vignette

r

devtools