Invoke a text editor on an R object.
## S3 method for class 'default': edit((name = NULL, file = "", title = NULL, editor = getOption("editor"), ...) vi(name = NULL, file = "") emacs(name = NULL, file = "") pico(name = NULL, file = "") xemacs(name = NULL, file = "") xedit(name = NULL, file = ""))
- a named object that you want to edit. If name is missing then the file specified by
fileis opened for editing.
- a string naming the file to write the edited version to.
- a display name for the object being edited.
- a string naming the text editor you want to use. On Unix the default is set from the environment variables EDITOR or VISUAL if either is set, otherwise
viis used. On Windows it defaults to
"internal", the script editor. On the Mac OS X GUI the argument is ignored and the document editor is always used.
- further arguments to be passed to or from methods.
edit invokes the text editor specified by
editor with the object
name to be edited. It is a generic function, currently with a default method and one for data frames and matrices.
It is important to realize that
edit does not change the object called
name. Instead, a copy of name is made and it is that copy which is changed. Should you want the changes to apply to the object
name you must assign the result of
fix if you want to make permanent changes to an object.) In the form
name into a temporary file and invokes the editor
editor on this file. Quitting from the editor causes
file to be parsed and that value returned. Should an error occur in parsing, possibly due to incorrect syntax, no value is returned. Calling
edit(), with no arguments, will result in the temporary file being reopened for further editing.
Note that deparsing is not perfect, and the object recreated after editing can differ in subtle ways from that deparsed: see
.deparseOpts. (The deparse options used are the same as the defaults for
dump.) Editing a function will preserve its environment. See
edit.data.frame for further changes that can occur when editing a data frame or matrix. Currently only the internal editor in Windows makes use of the
title option; it displays the given name in the window header.
Documentation reproduced from R 2.15.3. License: GPL-2.