[R] R package documentation

Ista Zahn istazahn at gmail.com
Fri Feb 24 13:07:56 CET 2012


On Friday, February 24, 2012 02:52:32 AM Matyas Sustik wrote:
> Hi All,
> I am asking for some clarification on R package documentation.
> The Writing R extension manual did not make this clear for me
> the following:
> 1. How to document a dataset?  I know the file format from the
> doc, but I cannot figure out what file to put that info in.
> I keep getting "Undocumented data sets:" errors and so clearly
> R is not looking where I put these...

If you use package.skeleton to create the docmentation templates, you should 
have templates for data sets as well. If not, you can load the data set and 
create a documentation template using prompt(). The data documentation should 
go in the man folder along with the function documentation.

> 2. How to create an index for demo files?  I keep getting
> the "Demos with missing or empty index information:" message.
> I created the 00Index file in the demo directory with 1 line per
> demo and the first word is the demo file name.  This does not
> appear to be what R is expecting.

Try separating the name and description with a tab instead of a space.


> This will be my first package... I have only these two warnings
> left... Thanks!
> -Matyas
> 	[[alternative HTML version deleted]]
> ______________________________________________
> R-help at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-help
> PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
> and provide commented, minimal, self-contained, reproducible code.

More information about the R-help mailing list