promptMethods(f, filename = NULL, methods)
f
followed by "-methods.Rd"
). Can also be
FALSE
or NA
(see below).f
, these would be documented). If this argument is supplied, it is likely to be
getMethods(f, where)
, with where
some package
containing methods for f
.
filename
is FALSE
, the text generated;
if filename
is NA
, a list-style representation of the
documentation shell.
Otherwise, the name of the file written to is returned invisibly.filename
is FALSE
, the text created is returned,
presumably to be inserted some other documentation file, such as the
documentation of the generic function itself (see
prompt
). If filename
is 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")
,
where x
is the list-style representation. Otherwise, the documentation shell is written to the file specified by
filename
.prompt
and
promptClass