R-alpha: naming convention for index files

Kurt Hornik Kurt.Hornik@ci.tuwien.ac.at
Sun, 7 Sep 1997 17:23:47 +0200

In the process of moving to the new directory structure, we might also
reconsider the naming of the various index files.

A simple idea would be to have an `INDEX' file in each directory where
this is appropriate.  E.g., we could have

	pkg/funs/INDEX		(rather than help/pkg/INDEX)
	pkg/data/INDEX		(rather than index.doc)
	pkg/help/INDEX		(rather than AnIndex)

or e.g.



The package TITLE files would be used for building the package index of
a library tree (LibIndex?)

In any case, the `plain' indices to be displayed upon calling an
appropriate form of help() could contain MORE than simply a list of
things.  I.e., more like a README.

My idea is (assuming only RHOME is in .lib.loc):

	R> library()

	`RHOME' is the location of the default R library tree.
	Blah blah blah ...

	Packages in `RHOME':

	base		The basic package.
	eda		...
	mva		...

The last lines could be generated from the packages' TITLE files.  The
other info from some stub, perhaps LibIndex.in?

As usual, any feedback is appreciated.


r-devel 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-devel-request@stat.math.ethz.ch