[英]chapters in R reference manual and documentation using roxygen2
Once I've seen a package supporting R program in which his documentation and reference manual was divided into chapters ( they were called by the consecutive letters of the alphabet ) so that an user could see that functions presented by that package are divided into groups. 一旦我看到了一个支持R程序的程序包,在该程序包中,他的文档和参考手册被分为几章(用连续的字母来称呼它们),以便用户可以看到该程序包提供的功能分为几组。
Now I'm trying to do the same. 现在,我正在尝试做同样的事情。 I'm building package using roxygen2 package but can not deal with that problem.
我正在使用roxygen2软件包构建软件包,但无法解决该问题。
Can any1 has any solution ? 可以解决任何问题吗? So in that case my documentation will be split to a file like this:
因此,在这种情况下,我的文档将被拆分为以下文件:
Group1:
funAX
funBX
funCX
Group2:
funAY
funBY
funCY
instead of 代替
funAX
funAY
funBX
funBY
funCX
funCY
A name of package that provides that solution will also be helpful. 提供该解决方案的软件包名称也将有所帮助。
In the lattice
package developers invented a way to order a documentation. 在
lattice
软件包中,开发人员发明了一种订购文档的方法。 They simply add letters in an alfabetic order to the beginning of a .Rd
file. 他们只是按字母顺序将字母添加到
.Rd
文件的开头。 This order might suggest the way of passing thru the manual to optimize understanding. 此命令可能会建议通过手册以增进理解的方法。 Manual is here .
手册在这里 。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.