问为R包生成可打印文档的标准选项是什么？
EN

Stack Overflow用户

提问于 2019-05-25 04:04:29

回答 1查看 40关注 0票数 0

当我查看R包的文档时，它通常出现在PDF文档中，如下所示：

那份文件有名字吗？

通常我是通过在网络上搜索来找到这些文档的，但我想知道是否也可以使用一些R命令来生成它们，比如library(help=...)或vignette(...)。然而，this answer让它听起来有点复杂，就像我必须自己编译包并运行R CMD Rd2pdf，对吗？

此外，作为一名未来的软件包作者，我可以想象将此PDF文档作为我的软件包的主要文档。唯一的障碍是，当我阅读这些文档时，文档中的函数似乎总是按字母顺序出现。有没有一种方法可以把最重要的函数放在第一位，这样文档就可以直接阅读(而不仅仅是作为参考)？或者，有没有另一种文档格式可以让我以特定的顺序记录文档？

回答已采纳

发布于 2019-05-25 06:35:13

参考手册只是帮助页面的集合。它们应该被写成参考材料，这可能不是用户应该查找文档的第一个地方，如果这就是你所说的“主要文档”的意思。

用户首先应该寻找的是一个小插图，它提供了一个包的概述。它可以以HTML或PDF格式显示(这取决于包作者的选择)。由于它是自由格式的，您可以按逻辑顺序记录内容，而不是局限于参考手册的字母顺序。

它也是可选的，我用它来衡量我正在调查的包的质量:如果他们没有这样的小插曲，作者就不会真正关心提供好的文档。

票数 1

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/56298922

复制

相似问题

问为R包生成可打印文档的标准选项是什么？EN