prompt.data.frame {base}R Documentation

Produce Prototype of an R Documentation File

Description

Facilitate the constructing of files documenting R data frames.

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

prompt.

help and the chapter on ``Writing R documentation'' in ``Writing R Extensions'' (see the `doc/manual' subdirectory of the R source tree).

Examples

data(women)
prompt(women)


[Package Contents]