\Header{prompt}{Produce Prototype of an R Documentation File}
\methalias{prompt.data.frame}{prompt}
\methalias{prompt.default}{prompt}
\keyword{documentation}{prompt}
\begin{Description}\relax
Facilitate the constructing of files documenting \R{} functions.\end{Description}
\begin{Usage}
\begin{verbatim}
prompt(object, ...)

prompt.default(object,
    filename = paste(name, ".Rd", sep = ""),
    force.function = FALSE, ...)

prompt.data.frame(object,
    filename = paste(name, ".Rd", sep = ""), ...)
\end{verbatim}
\end{Usage}
\begin{Arguments}
\begin{ldescription}
\item[\code{object}] an \R{} object, typically a function
\item[\code{filename}] name of the output file
\item[\code{force.function}] treat \code{object} as function in any case
\item[\code{...}] further arguments passed to or from other methods.
\end{ldescription}
\end{Arguments}
\begin{Details}\relax
An ASCII file \code{filename} is produced containing the proper
function and argument names of \code{object}.  You have to edit it
before adding the documentation to the source tree, i.e., (currently)
to \file{\$R\_HOME/src/library/base/man/}.\end{Details}
\begin{Note}\relax
The documentation file produced by \code{prompt.data.frame} does not
have the same format as many of the data frame documentation files in
the \code{base} library.  We are trying to settle on a preferred
format for the documentation.\end{Note}
\begin{Author}\relax
Douglas Bates for \code{prompt.data.frame}\end{Author}
\begin{SeeAlso}\relax
\code{\Link{help}} and the chapter on ``Writing \R{} documentation'' in
``Writing \R{} Extensions'' (see the \file{doc/manual}
subdirectory of the \R{} source tree).\end{SeeAlso}
\begin{Examples}
\begin{ExampleCode}
prompt(plot.default)
prompt(interactive, force.function = TRUE)
unlink("plot.default.Rd")
unlink("interactive.Rd")

data(women) # data.frame
prompt(women)
unlink("women.Rd")

data(sunspots) # non-data.frame data
prompt(sunspots)
unlink("sunspots.Rd")
\end{ExampleCode}
\end{Examples}

