ereprompt: Update an Rd file and open it in an editor

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/repromptAny.R

Description

Update an Rd file and open it in an editor. This is a wrapper for reprompt with different defaults for some parameters.

Usage

1
ereprompt(..., edit = TRUE, filename = TRUE)

Arguments

...

passed on to reprompt, see its documentation for details.

edit

if TRUE, the default, open an editor when finished.

filename

if TRUE, the default, replace and/or edit the original Rd file.

Details

ereprompt calls reprompt to do the actual job but has different defaults for the arguments described on this page. By default, it replaces the original Rd file with the updated documentation and opens it in an editor.

Value

called for the side effect of updating Rd documentation file and opening it in an editor

Author(s)

Georgi N. Boshnakov

See Also

reprompt which does the actual work

Examples

1
2
3
4
5
6
## this assumes that the current working directory is
## in any subdirectory of the development directory of  Rdpack 
## Not run: 
ereprompt(infile = "reprompt.Rd")

## End(Not run)

GeoBosh/Rdpack documentation built on Oct. 29, 2018, 8:22 p.m.