The "data index" is mentioned in the R Extensions Writer guide as>> The subdirectory should contain a `00Index' file >> that describes the datasets available.I'm not sure what the official format is suppose to be, but given that it displays like an index, this has to be a very short description which I find somewhat inadequate. Some of my data sets are multivariate time series and it is impossible to describe them in such a brief format, so I have resorted to very poor descriptions like "data used in ...". It would be nice to have a facility to give a more complete description of the data. Paul Gilbert -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.- 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 _._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._
> Date: Mon, 10 Apr 2000 09:25:52 -0400 > From: Paul Gilbert <pgilbert@bank-banque-canada.ca> > To: r-devel <r-devel@stat.math.ethz.ch> > Subject: [Rd] 00Index of data > > The "data index" is mentioned in the R Extensions Writer guide as > >> The subdirectory should contain a `00Index' file > >> that describes the datasets available. > > I'm not sure what the official format is suppose to be, but given that > it displays like an index, this has to be a very short description which > I find somewhat inadequate. Some of my data sets are multivariate time > series and it is impossible to describe them in such a brief format, so > I have resorted to very poor descriptions like "data used in ...". It > would be nice to have a facility to give a more complete description of > the data.There is no restriction on the format. The only use is with data() to show what is available. But a few lines should suffice to indicate if it is worth looking up the help page for the data. (And that needs a one-line title.) The same comments apply to the INDEX file: you can let build generate it, but several packages have hand-customised files (e.g.boot). -- Brian D. Ripley, ripley@stats.ox.ac.uk Professor of Applied Statistics, http://www.stats.ox.ac.uk/~ripley/ University of Oxford, Tel: +44 1865 272861 (self) 1 South Parks Road, +44 1865 272860 (secr) Oxford OX1 3TG, UK Fax: +44 1865 272595 -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.- 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 _._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._
> Date: Mon, 10 Apr 2000 10:25:41 -0400 > From: Paul Gilbert <pgilbert@bank-banque-canada.ca> > To: Prof Brian Ripley <ripley@stats.ox.ac.uk> > CC: r-devel@stat.math.ethz.ch > Subject: Re: [Rd] 00Index of data > > >the help page for the data. > > Now that's something I didn't know about but is probably documented > somewhere that I missed. (No wonder I found the index rather > restrictive.) I now see it is reported as missing documentation by R CMD > build. (It is buried by all the other warnings.) I guess it should justWhen you solve all the others it will emerge more clearly :)> be an Rd file like the function help.Yes, and `Writing R Extensions' tells you about making help files for data. And the base system has them. (So does S-PLUS!)> Does a link get automatically > built from the 00Index of the data to the help for data or do I need to > point readers to the help?Readers are supposed to know to look for help on R *objects* (not just functions). Even the help.start intro says `Functions & Datasets'> Or will the 00Index of the data get built > automatically from the titles in the data help files in the same way > that the function index is built? (And if so, how does it know the > documentation is for data?)It does not get built, and help for data goes in INDEX. (That is one reason why some of us prefer hand-crafted INDEX files.) We are moving towards a way to distinguish the object type in a help file, but are not there yet. -- Brian D. Ripley, ripley@stats.ox.ac.uk Professor of Applied Statistics, http://www.stats.ox.ac.uk/~ripley/ University of Oxford, Tel: +44 1865 272861 (self) 1 South Parks Road, +44 1865 272860 (secr) Oxford OX1 3TG, UK Fax: +44 1865 272595 -.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.- 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 _._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._