R-alpha: suggestion for the R help system

Kurt Hornik (Kurt.Hornik@ci.tuwien.ac.at)
Wed, 13 Nov 1996 11:59:38 +0100


Date: Wed, 13 Nov 1996 11:59:38 +0100
Message-Id: <199611131059.LAA12930@aragorn.ci.tuwien.ac.at>
From: Kurt Hornik <Kurt.Hornik@ci.tuwien.ac.at>
To: r-testers@stat.math.ethz.ch
Subject: R-alpha: suggestion for the R help system

As more and more S packages get ported to R (Thomas has survival and
gee, and Fritz just completed fracdiff), it might be a good idea to
start thinking about how to add documentation for new packages to the R
help system.

I have the following suggestion:

* For the time being, stay with a flat help file directory (Eventually,
it would of course be better to have one directory per package).

* Have a separate index file for each package, with the naming
convention

	AnIndex.${package_name}

* Have a trivial shell script which `builds' the real index by doing

	cat AnIndex.* | uniq | sort > AnIndex

in the R help directory.

* I also have two trivial scripts which convert S man (nroff) source to
help files useable by R and build an index, respectively.

Opinions?

-k

PS.  For all of us Debian GNU/Linuxers out there.  The postinst script
for an add-on R package could then simply call the script which updates
the index ... :-)
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
r-testers mailing list -- To (un)subscribe, send
subscribe	or	unsubscribe
(in the "body", not the subject !)  To: r-testers-request@stat.math.ethz.ch
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-