promptPackage
Make a skeleton help file for a package
Description
Make a skeleton help file for a package as a whole.
Usage
promptPackage(package, lib.loc = NULL, filename = NULL,
name = NULL, final = FALSE)
Arguments
| package |
a character string giving the name of the package to be documented.
|
| lib.loc |
a character vector containing the names of library directories.
If lib.loc is NULL, .libPaths() is used.
|
| filename |
a character string giving the name of a file or a connection in which to document.
It can be either NULL or NA. If NULL, the filename
is name followed by ".Rd". If NA, the function
promptPackage does not write the generated documentation to any files.
Instead, it returns a list object.
|
| name |
a character string giving the name of the help topic. The default is NULL,
and name is package followed by "-package".
|
| final |
a logical value. If TRUE, some placeholder slots with "~~" are not
included in generated documentation.
Normally, these slots can be edited manually later.
|
Details
If you make the skeleton package help file from an installed package, it
includes a list of all functions in the package, along with the "Title" lines
from their documentation files. If you use a source package directory, this
list is not in the help file.
Value
returns a list object representing the documentation shell if filename is NA;
otherwise, returns filename invisibly.
See Also
Examples
## Not run:
promptPackage("utils", filename = "utils-pkg.Rd")
promptPackage("utils", filename = "utils-pkg-final.Rd", final = TRUE)
file.show("utils-pkg.Rd")
file.show("utils-pkg-final.Rd")
unlink("utils-pkg.Rd")
unlink("utils-pkg-final.Rd")
## End(Not run)
promptPackage("utils", filename = NA)