Generate Outline Documentation for a Data Set
Generates a shell of documentation for a data set.
promptData(object, filename = NULL, name = NULL)
- an Robject to be documented as a data set.
- usually, a connection or a character string giving the
name of the file to which the documentation shell should be written.
The default corresponds to a file whose name is
".Rd". Can also be
- a character string specifying the name of the object.
NA, a documentation shell for
object is written to the file specified by
a message about this is given.
NA, a list-style representation of the
documentation shell is created and returned. Writing the shell to a
file amounts to
cat(unlist(x), file = filename, sep = "\n"),
x is the list-style representation.
Currently, only data frames are handled explicitly by the code.
NA, a list-style representation of the documentation shell. Otherwise, the name of the file written to is returned invisibly.