New features in Rd format

Friedrich Leisch
Wed, 14 Jan 1998 15:28:09 +0100

I have added the following features to the Rd format:

* Sd output format as contributed by Doug Bates ... this should create
help files for S[+] from Rd files

* New sections Format and Source ... both are necessary for
documentation of data files (these are not supported by Sd yet, but
should work for html, nroff and latex)

E.g., the documentation source for the acid data now looks like:


\title{Determination of Formaldehyde}
\format{A data frame with 6 observations on 2 variables.

  [,1]  \tab carb  \tab numeric  \tab Carbohydrate (ml) \cr
  [,2]  \tab opt   \tab numeric  \tab Optical Density \cr
\description{These data are from an chemical experiment to prepare a standard cur
for the determination of formaldehyde by the addition of chromatropic
acid and concentrated sulpuric acid and the reading of the resulting
purple color on a spectophotometer.

\source{Bennett, N. A. and N. L. Franklin (1954).  Statistical analysis in
Chemistry and the Chemical Industry.  New York: Wiley
\references{McNeil, D. R. (1977).  Interactive Data Analysis.  New York: Wiley.


Eventually all data files will be documented using the Rd format
... it just needs somebody with some extra time ...


r-devel mailing list -- Read
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: