1\name{.capture_promptAny} 2 3\alias{.capture_promptAny} 4\alias{.capture_installed_help} 5 6%- Also NEED an '\alias' for EACH other topic documented here. 7 8\title{Internal functions used by reprompt} 9 10\description{Internal functions used by reprompt.} 11 12\usage{ 13.capture_promptAny(fnam, type, package, final, \dots, methods) 14 15.capture_installed_help(fnam, type = NULL, package = NULL, 16 suffix = NULL) 17} 18 19%- maybe also 'usage' for other objects documented here. 20 21\arguments{ 22 \item{fnam}{extended name of the object, such as "fun", "gen-methods", 23 "S4cl-class" or "pkname-package", see details.} 24 \item{final}{if TRUE, put dummy title and description to make the 25 file immediately usable.} 26 \item{\dots}{further arguments to pass on to the prompt function(s).} 27 \item{methods}{methods to consider, used only when describing S4 methods.} 28 \item{type}{type of documentation, such as "methods" and "class", see 29 Details.} 30 \item{package}{the package where to look for objects or documentation, 31 useful if more objects of the same name exist.} 32 \item{suffix}{a character string to be appended to \code{fnam} to 33 obtain the complete name of the help topic, e.g. "-class", 34 "-method". 35 } 36} 37 38\details{ 39 These functions are used internally by \code{reprompt}. It falls back 40 to them when only when the user has not supplied an Rd file in the 41 call. 42 43 Note that for editing it is preferable to use the source Rd files 44 (when available), since some hard coded information in the installed 45 help may have been produced by more elaborated code in the Rd sources, 46 most notably Sweave expressions. 47 48 \code{.capture_promptAny} is used to generate documentation when none 49 has been supplied by the user or loaded in the session. 50 \code{.capture_promptAny} parses \code{fnam} to obtain the name of the 51 object and the type of the required documentation (function, methods, 52 class), then generates it. Currently this is done with the built in 53 functions of the \code{promptXXX} family. 54 55 \code{.capture_installed_help} does exactly that --- it captures the 56 currently installed requested help topic. This function needs clean 57 up. It was originally written at a time when both the old and new help 58 formats where co-existing. 59} 60 61\value{ 62 an Rd object on success or a \code{try-error} object otherwise 63} 64 65 66 67\author{Georgi N. Boshnakov} 68 69 70 71 72%% ~Make other sections like Warning with \section{Warning }{....} ~ 73 74 75 76 77\examples{ 78##---- Should be DIRECTLY executable !! ---- 79} 80 81% Add one or more standard keywords, see file 'KEYWORDS' in the 82 83% R documentation directory. 84 85\keyword{internal} 86