| prompt.data.frame {base} | R Documentation |
Produce Prototype of an R Documentation File
Description
The main goal is to facilitate the constructing of files documenting data frames in R.
An ASCII file filename is produced containing the data frame
name and the names of the variables in the frame. You have to edit it
before adding the documentation to the source tree, i.e., (currently)
to ‘\$R\_HOME/src/library/base/man/’.
Usage
prompt.data.frame(object, filename = paste(name, ".Rd", sep = ""))
Arguments
object |
a data frame |
filename |
name of the output file |
Note
The documentation file produced by prompt.data.frame does not
have the same format as many of the data frame documentation files in
the base library. We are trying to settle on a preferred
format for the documentation.
Author(s)
Douglas Bates bates@stat.wisc.edu
See Also
help and the tutorial about writing R documentation,
currently in the file ‘\$R\_HOME/doc/manual/writing-Rd.tex’.
Examples
data(women)
prompt(women)