[R] Organizing the help files in a package

Uwe Ligges ligges at statistik.uni-dortmund.de
Mon Apr 29 17:51:47 CEST 2002

"Rangrej, Jagadish" wrote:
> Dear all!!
> I am using R1.4.1 on windows 98.
> I had been trying to organize the package and has already been able to
> document some of the functions in to .Rd (R documentation) files. From these
> .Rd files I generated plain text files as well as html files.

That will be done automatically by Rcmd INSTALL (for an already builded
package) and is not needed before Rcmd BUILD.

> I have also given the 00Index file in each of the directories:
> html/
> help/
> data/
> man/

The first two are not needed, but a directory called "R" is missing
which should contain your *.R files.

> Problem: I don't get the help using comand "help" after loading the package
> using library command. Some how the html index gets updated and the help is
> available in the link of packages in html help pages.
> I tried using the command:
> > Rcmd build,
> gives the following error
> * checking for file `pubbias/DESCRIPTION' ... OK
> * preparing `pubbias':
> * checking whether `INDEX' is up-to-date ... OK
> * checking whether `data/00Index' is up-to-date ... O
> * removing junk files
> * building `pubbias_1.0.tar.gz'
> Bad command or file name
> Bad command or file name
> So I organized it mannually to pubbias.zip.
> any help will be greatly appreciated.

Do you have installed all the tools needed to build a package?

For details please read the manual "Writing R Extensions".

Uwe Ligges
r-help mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: r-help-request at stat.math.ethz.ch

More information about the R-help mailing list