手册和小插图有什么区别?

时间:2016-01-12 21:46:59

标签: r manual vignette

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

1 个答案:

答案 0 :(得分:6)

参考手册

软件包的参考手册是一个单独的文档,以软件包描述开头,包含软件包的.Rd帮助文件中的所有内容。通常,这意味着它包含包中函数的帮助文件,任何记录的数据集和包级文档(如果包含)。它是从.Rd来源自动生成的。

每个包都有一本手册。即使是没有导出函数和文档的包,仍然会有一个由描述文件中的文本组成的手册(构建时)。

晕影

Vignettes是自由格式的文件。通常,包装作者使用它们来演示其包装的使用。它们是可选的,有些包有几个(我写这个dplyr has 8 vignettes),很多包都没有。

正如评论中所提到的,R扩展手册是与软件包相关的所有内容的权威来源。 Here is Josh's link to the Vignettes Section2.15 Processing documentation files描述了如何构建参考手册。