[R-pkg-devel] Category (Subjection) in R documentation for package

Duncan Murdoch murdoch.duncan at gmail.com
Sun Oct 1 20:50:19 CEST 2017

On 01/10/2017 12:42 PM, Mohammad Tanvir Ahamed via R-package-devel wrote:
> I am building package R-studio (Roxygen2).
> In the package function documentation, now the standard format is to show all function name.
> Now I want to categorize those function under some section/heading.
> Can any one please hey me regarding this issue?
> Is there any way or idea how one can do it ?

I don't know how to do this with Roxygen2, but what you want to get is a 
package help page (typically yourpackage-package.Rd with 
\alias{yourpackage-package}, and maybe also \alias{yourpackage}).  On 
that page you can have sections using

    some content

The "some content" can be a list of links to your help topics using 
\itemize, \enumerate, or \tabular.  See the built-in manual "Writing R 
Extensions", and presumably some Roxygen2 documentation to tell you how 
to let all of this get through to the .Rd file.

Duncan Murdoch

More information about the R-package-devel mailing list