[R] help file extension
dmurdoch at pair.com
Mon Sep 1 23:24:11 CEST 2003
On Mon, 1 Sep 2003 22:18:40 +0200, you wrote:
>I've been struggling with the following problem... Normally, if you build a
>package, the help files are created automatically (by 'converting' the Rd-files)
>in pdf- and/or html-format. I have some additional information, about the
>general purpose and how-to-use of the package, actually, it's a scheme. This is
>made in LaTeX. Can anyone give me a clue of how to include this scheme (and some
>text) in the pdf- (and probably html-)help files while building the package?
You can put additional documentation in a "doc" subdirectory, but it
won't be included in the automatically generated reference manual. I
think the only way to do that is to put it in an Rd file. Allowing
the user to easily include a general introduction at the start of that
file sounds like it would be a nice enhancement.
A somewhat commonly used convention is to put general package info
about package foo into foo.Rd, but in some cases (e.g. boot) this name
is already taken.
More information about the R-help