r - 我可以使用 R 笔记本作为 R 包小插图吗？

Question

我知道我可以使用 Rmd 来构建包插图，但想知道是否可以更具体地使用 R Notebooks 来制作包插图。如果是这样，我需要将 R Notebooks 编写为包小插图有什么不同吗？我正在使用最新版本的 RStudio 和 devtools 来编写这个包。

Answer 1

您的两个问题的简短答案分别是"is"和“否”。

理解 R Notebooks 的关键是它们不是不同种类的文件；作为 documentation说:

Any R Markdown document can be used as a notebook

由于 vignettes 是 R Markdown 文档(在其 YAML header block 中带有 output: rmarkdown::html_vignette)，因此它们可以用作 R 笔记本。

那么，如果 R Notebooks 不是另一种文件，那它们是什么？

同样，文档很简洁:

A notebook can therefore be thought of as a special execution mode for R Markdown documents

换句话说，它只是改变了您与文件的交互。这些变化主要与使代码开发过程更具交互性和动态性有关。也许最重要的是:

• 交互式代码执行:您可以根据需要执行行或 block (与整个 R Markdown 文档的批处理模式渲染相比)
• 嵌入代码输出:您可以在文件的文本编辑缓冲区中看到交互式编码 session 的结果，并且这些结果会在您运行、更改和重新运行时更新代码。
• 笔记本文件:这有点复杂，不一定与小插图相关，但值得一提。当您保存一个 .Rmd 文件，该文件在 YAML header block 中具有 output: rmarkdown::html_notebook 时，另一个 文件会在同一目录中创建，文件扩展名为 .nb.html。这个“Notebook 文件”存储所有代码块的输出，无论它们在保存时处于何种状态。它的用处有两个。首先，当您重新打开相关的 .Rmd 文件时，这些输出会重新加载供您查看，而无需重新运行任何代码(尽管对于其他输出也以隐藏方式处理)类型)。其次，您可以直接在任何网络浏览器中打开这些 .nb.html 文件，它们将显示笔记本状态的呈现 .html 版本。此功能使它们可用于共享，并且“随用随取”的特性使您无需在每次想要查看未完成笔记本的中间状态时都点击 knit。

在 RStudio 中编辑时，所有 .Rmd 文档都被视为 R Notebooks(无论它们的 output: 字段是什么)，所以您不需要做任何事情，它不会影响您的小插图构建过程。

我不确定 vignettes 是否可以通过添加 both output: rmarkdown::html_vignette and output: rmarkdown::html_notebook 到他们的 YAML 头 block 。我试了一下，但似乎没有用。