prompt.function: Produce a prototype of an Rd (R Documentation) file, from a...

In drmjc/updateR: Package development toolkit

Description

Produce a prototype of an Rd (R Documentation) file, from a function definition. In fact, there was never a prompt.function in prompt, just a prompt.default, so I haven't over-written anything from utils. This code originally came from “src/library/utils/R/prompt.R”

Usage

  prompt.function(object, filename = NULL, name = NULL,
    force.function = FALSE, ...)

Arguments

object	an R object, typically a function for the default method. Can be missing when name is specified.
filename	usually, a connection or a character string giving the name of the file to which the documentation shell should be written. The default corresponds to a file whose name is ‘name’ followed by “.Rd”. Can also be ‘NA’ (see below).
name	a character string specifying the name of the object.
force.function	logical: If TRUE, treat ‘object’ as function in any case.
...	further arguments passed to or from other methods.

Value

If ‘filename’ is NA, a list-style representation of the documentation shell. Otherwise, the name of the file written to is returned invisibly.

Author(s)

Mark Cowley, 2009-10-13

drmjc/updateR documentation built on May 15, 2019, 2:41 p.m.