r - 手册和小插图有什么区别？

Question

我一直在阅读 R 的 Affy 手册，它指的是其他小插曲。这两个术语之间的区别只是与内容的数量有关，还是有更多？

Answer 1

参考手册

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

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

小插图

插图是自由格式的文档。通常，包作者使用它们来演示其包的使用。它们是可选的，一些包有几个（我写这个dplyr 有 8 个小插图），很多包没有。

---

正如评论中提到的，R 扩展手册是所有与包相关的东西的权威来源。这是 Josh 到 Vignettes 部分的链接，2.15 处理文档文件描述了如何构建参考手册。