手册和插图有什么区别？

Question

我一直在通读 R 的 Affy 手册，其中提到了其他小插曲。这两个术语之间的区别仅与内容的数量有关，还是与内容的数量有关？

Answer 1

参考手册

包的参考手册是以包描述开头的单个文档，包含包的 .Rd 帮助文件中的所有内容。通常，这意味着它具有包中（导出的）函数的帮助文件、任何记录的数据集和 package-level 文档（如果包含）。它是从 .Rd 来源自动生成的。

每个包都有一个手册。即使没有导出函数和文档的包仍然会有一个手册（构建时），其中包含描述文件中的文本。

小插曲

插图是 free-form 文档。通常，包作者使用它们来演示其包的使用。它们是可选的，有些包有几个（正如我写的 dplyr has 8 vignettes），许多包有 none.

---

如评论中所述，R 扩展手册是所有内容的权威来源 package-related。 Here is Josh's link to the Vignettes Section, and 2.15 Processing documentation files 描述了参考手册是如何构建的。