当我查看R软件包的文档时,通常是这样的PDF文档:
https://cran.r-project.org/web/packages/glmnet/glmnet.pdf
该文件有名字吗?
通常我可以通过在网络上搜索找到这些文档,但是我想知道是否还可以使用诸如library(help=...)
或vignette(...)
之类的R命令来生成它们。但是,this answer听起来有些复杂,就像我必须自己编译软件包并运行R CMD Rd2pdf
那样吗?
此外,作为准软件包的作者,我可以想象将此PDF文档用作我的软件包的主要文档。唯一的障碍是,当我阅读这些文档时,所记录的功能似乎总是按字母顺序出现。有没有办法将最重要的功能放在首位,以便可以直接阅读文档(而不只是作为参考)?还是有另一种文档格式可以让我按一定顺序进行记录?
答案 0 :(得分:1)
参考手册只是帮助页面的集合。应该将它们作为参考材料来编写,如果这不是“主要文档”的意思,那么这可能不是用户应该首先查找文档的地方。
用户应该首先关注的是提供包装概述的装饰图案。它可以HTML或PDF格式显示(由包作者选择)。由于它是自由格式,因此您可以按逻辑顺序记录事物,而不仅限于参考手册的字母顺序。
它也是可选的,我用它来衡量我正在研究的软件包的质量:如果他们没有这样的插图,那么作者就真的不在乎提供好的文档。