Hi, I wrote all documents for each objects in my package in one .Rd file. Now I can't convert the .Rd file into multi html files such that a html file corresponds a object in package. The command I used was ' R CMD Rdconv -t html foo.Rd'. It just converted the document of first object in .Rd into html format. I had to write a perl script to satisfy myself. But is there a more direct and simple way to do it? Thank you very much. your sincerely, Yiming Zhou --------------------------------- [[alternative HTML version deleted]]
Yiming Zhou wrote:> Hi, > I wrote all documents for each objects in my package in one .Rd file. Now I can't convert the .Rd file into multi html files such that a html file corresponds a object in package. > The command I used was ' R CMD Rdconv -t html foo.Rd'. It just converted the document of first object in .Rd into html format. > > I had to write a perl script to satisfy myself. But is there a more direct and simple way to do it? > > Thank you very much. > > your sincerely, > > Yiming ZhouThe idea is to have one Rd file for each function -- with some exceptions, hence this is not supported. Why don't you build a package? With the right \alias{} entries, you will get that help page for any help() call of an aliased topic. Uwe Ligges
Hi! On Tue, Sep 09, 2003 at 04:17:25AM -0700, Yiming Zhou wrote:> The command I used was ' R > CMD Rdconv -t html foo.Rd'. It just converted the document of first > object in .Rd into html format.I'm not exactly an expert in writing R documentation but while playing arround with package building I initially had the same problem. By looking at other peoples *.Rd files I discovered that you need to separate individual sections of documentation by \eof. "Writing R Extensions" doesn't seem to mention this, though. hope it helps Philipp -- Dr. Philipp Pagel Tel. +49-89-3187-3675 Institute for Bioinformatics / MIPS Fax. +49-89-3187-3585 GSF - National Research Center for Environment and Health Ingolstaedter Landstrasse 1 85764 Neuherberg, Germany
The R packaging programs expect one .Rd file for each function, all in the man directory. Installing the package converts each .Rd file into an html file as well as other documentation formats. There was once some discussion of allowing multiple functions to be documented in a single file, but I believe that has never been done. Maintaining a number of packages I find it somewhat inconvenient to deal with the very large number of source files this system implies, so I have another directory I call mansrc, which does not get included in packages. This directory has one file I call whatever.help, where "whatever" corresponds to a code file R/whatever.R that contains code for multiple functions. I then process this through a perl script to produce man/*.Rd files that are included in packages. I would be happy to supply the perl script, but it sounds like you have already written your own. I doubt that my system is worth the extra complexity unless you are documenting a large number of functions. Paul Gilbert Yiming Zhou wrote:>Hi, >I wrote all documents for each objects in my package in one .Rd file. Now I can't convert the .Rd file into multi html files such that a html file corresponds a object in package. >The command I used was ' R CMD Rdconv -t html foo.Rd'. It just converted the document of first object in .Rd into html format. > >I had to write a perl script to satisfy myself. But is there a more direct and simple way to do it? > >Thank you very much. > >your sincerely, > >Yiming Zhou > >
Paul Gilbert wrote:> The R packaging programs expect one .Rd file for each function, ...Sorry, this was not exactly correct. It expects one .Rd file for each documentation item (man page) indicated by \name{}, but that can document more than one function. Paul Gilbert