chapters in R reference manual and documentation using roxygen2

巧了我就是萌 提交于 2019-12-02 14:34:14

问题


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.

Now I'm trying to do the same. I'm building package using roxygen2 package but can not deal with that problem.

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.


回答1:


In the lattice package developers invented a way to order a documentation. They simply add letters in an alfabetic order to the beginning of a .Rd file. This order might suggest the way of passing thru the manual to optimize understanding. Manual is here.



来源:https://stackoverflow.com/questions/25293137/chapters-in-r-reference-manual-and-documentation-using-roxygen2

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!