[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
S is a powerful system for manipulating and analyzing data, but its user interface -- particularly on Unix platforms -- leaves something to be desired. ESS is a package which is designed to make S easier to use.
ESS provides several features which make it easier to interact with the ESS process (i.e. enter commands and view the output). These include:
Command-line editing for fixing mistakes in commands before they are entered. The `-e' flag for S-plus provides something similar to this, but here you have the full range of Emacs commands rather than a limited subset. However, other packages such as XLisp-Stat and S3 do not necessarily have features like this built-in. See section Entering commands and fixing mistakes.
Searchable command history for recalling previously-submitted commands. This provides all the features of the `Splus -e' history mechanism, plus added features such as history searching. See section Command History.
Command-line completion of both object and file names for quick
entry. This is similar to tcsh
's facility for filenames; here it
also applies to object names and list components.
See section Completion of object names.
Hot-keys for quick entry of commonly-used commands in `S' such as
objects()
and search()
.
See section Hot keys for common commands.
Transcript recording for a complete record of all the actions in an S session. See section Manipulating the transcript.
Interface to the help system, with a specialized mode for viewing S help files. See section Reading help files in ESS.
If you commonly create or modify S functions, you will have found the standard facilities for this (the `fix()' function, for example) severely limiting. Using S's standard features, one can only edit one function at a time, and you can't continue to use S while editing. ESS corrects these problems by introducing the following features:
Object editing. ESS allows you to edit more than one function simultaneously in dedicated Emacs buffers. The ESS process may continue to be used while functions are being edited. See section Creating or modifying S objects.
A specialized editing mode for S code, which provides syntactic indentation and highlighting. See section Indenting and formatting S code.
Facilities for loading and error-checking source files, including a keystroke to jump straight to the position of an error in a source file. See section Detecting errors in source files.
Source code revision maintenance, which allows you to keep historic versions of S source files. See section Maintaining S source files.
Facilities for evaluating S code such as portions of source files, or line-by-line evaluation of files (useful for debugging). See section Sending code to the ESS process.
Finally, ESS provides features for re-submitting commands from saved transcript files, including:
Evaluation of previously entered commands, stripping away unnecessary prompts. See section Re-submitting commands from the transcript.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Changes/New Features in 5.2.1:
ESS[R]: If you have other versions of R, such as "R-1.8.1" on your exec-path, ESS will find and create appropriate functions, such as M-x R-1.8.1, for calling them. By default only programs beginning "R-1" and "R-2" will be found, but see ess-r-versions for ways to find other versions of R.
ESS[S] (R and S-plus): now have toolbar support with icons to evaluate code in the inferior process or to switch there. This code is experimental and likely to change as XEmacs/Emacs issues get resolved. The toolbar should be enabled if your Emacs displays images, but can be disabled with the variable ess-use-toolbar. Thanks to David Smith from Insightful for the S-plus logo.
ESS[SAS]: ess-sas-graph-view (F12) enhanced; you can specify external file viewers for each graphics file type via the alist ess-sas-graph-view-viewer-alist; also .jpg/.gif are now handled by image-mode on XEmacs, if available, otherwise by graphics primitives as before
Changes/New Features in 5.2.0:
ESS[BUGS]: new info documentation! now supports interactive processing thanks to Aki Vehtari; new architecture-independent unix support as well as support for BUGS v. 0.5
ESS[SAS]: convert .log to .sas with ess-sas-transcript; info documentation improved; Local Variable bug fixes; SAS/IML statements/functions now highlighted; files edited remotely by ange-ftp/EFS/tramp are recognized and pressing SUBMIT opens a buffer on the remote host via the local variable ess-sas-shell-buffer-remote-init which defaults to "ssh"; changed the definition of the variable ess-sas-edit-keys-toggle to boolean rather than 0/1; added the function ess-electric-run-semicolon which automatically reverse indents lines containing only "run;"; C-F1 creates MS RTF portrait from the current buffer; C-F2 creates MS RTF landscape from the current buffer; C-F9 opens a SAS DATASET with PROC INSIGHT rather than PROC FSVIEW; C-F10 kills all buffers associated with .sas program; "inferior" aliases for SAS batch: C-c C-r for submit region, C-c C-b for submit buffer, C-c C-x for goto .log; C-c C-y for goto .lst
ESS[S]: Pressing underscore ("_") once inserts " <- " (as before); pressing underscore twice inserts a literal underscore. To stop this smart behaviour, add "(ess-smart-underscore nil)" to your .emacs after ess-site has been loaded; ess-dump-filename-template-proto (new name!) now can be customized successfully (for S language dialects); Support for Imenu has been improved; set ess-imenu-use-S to non-nil to get an "Imenu-S" item on your menubar; ess-help: Now using nice underlines (instead of `nuke-* ^H_')
ESS[R]: After (require 'essa-r), M-x ess-r-var allows to load numbers from any Emacs buffer into an existing *R* process; M-x ess-rdired gives a "directory editor" of R objects; fixed ess-retr-lastvalue-command, i.e. .Last.value bug (thanks to David Brahm)
ESS: Support for creating new window frames has been added to ESS. Inferior ESS processes can be created in dedicated frames by setting inferior-ess-own-frame to t. ESS help buffers can also open in new frames; see the documentation for ess-help-own-frame for details. (Thanks to Kevin Rodgers for contributing code.)
Changes/New Features in 5.1.24:
The version number is now correct even inside ESS/Emacs
Changes/New Features in 5.1.23:
Minor more Makefile clean up.
Changes/New Features in 5.1.22:
Besides info documentation, PDF and HTML documentation are also provided (instead of built using "make") and available on the web as well; see ESS web page and StatLib
Now that info documentation is available, the README.* files are no longer supported. However, they are still distributed for what it's worth.
ESS is now an XEmacs package! See XEmacs Installation HOWTO for details (specifically, items 10-15).
ESS[SAS]: more user-friendly enhancements for remote SAS batch jobs with Kermit file transfers (LOG and OUTPUT function key features now supported). Multiple shells now supported so you can run SAS on different computers from different buffers by setting the buffer-local variable ess-sas-shell-buffer to unique buffer names.
Major re-vamping of Makefile/Makeconf.
Changes/New Features in 5.1.21:
ESS[SAS]: info documentation now available!, see ESS->Help for SAS; F12 opens GSASFILE nearest point for viewing either within emacs, when available, or via an external viewer; more syntax highlighting keywords; more enhancements for remote SAS batch jobs with Kermit; new framework for remote SAS interactive jobs, see ess-remote
ESS[S]: info documentation now available!, see ESS->Help for the S family
Makefile: tag now independent of rel; info files made by doc/Makefile and installed in new info sub-directory
Changes/New Features in 5.1.20:
New `options()$STERM' in the S dialects (S, S-Plus, R). The S program can determine the environment in which it is currently running. ESS sets the option to `iESS' or `ddeESS' when it starts an S language process. We recommend other specific values for S language processes that ESS does not start.
New `ess-mouse-me' function, assigned to S-mouse-3 by default. User may click on a word or region and then choose from the menu to display the item, or a summary, or a plot, etc. This feature is still under development.
GNU Emacs 21.1 is now supported (fixed for S dialects, SAS & BUGS), (some from Stephen Eglen).
XEmacs 21.x is now supported (fixed w32-using-nt bug)
XEmacs on Win (NT) is better supported.
Workaround for bug in Sqpe+6 (S-PLUS 6 for Win).
should now work even when imenu is not available (for old Xemacsen).
ESS[SAS]: XEmacs-Imenu fix; C-TAB is globalized along with your function-key definitions, if specified; you can specify your SAS library definitions outside of autoexec.sas for ess-sas-data-view with SAS code placed in the variable ess-sas-data-view-libname, also the dataset name is defaulted to the nearest permanent dataset to point; Speedbar support now works for permanent datasets, please ignore first./last.; new font-locking is now the default with more improvements for font-locking PROCs, macro statements, * ; and %* ; comments; you can toggle sas-log-mode with F10 which will font-lock your .log (if it isn't too big); submit remote .sas files accessed with ange-ftp, EFS or Tramp (Kermit is experimental) by setting ess-sas-submit-method to 'sh; ess-sas-submit-command and ess-sas-submit-command-options are buffer-local so you can have local file variable sections at the end of your .sas files to request different executables or specify special options and the local file variables are re-read at submit instead of only at file open so that if you make a change it is picked up immediately;
ESS[BUGS]: font-lock with `in' fixed.
for STATA: font-lock bug fixed.
for Rd mode: C-c C-v and `switch-process' in menu. further, C-c C-f prefix (Rd-font) for inserting or surrounding a word by things such as \code{.}, \code{\link{.}}, \emph{.} etc.
new functions (ess-directory-function) and (ess-narrow-to-defun) ess-directory <-> default-directory logic (Jeff Mincy).
Re-organized Makefile and fixed a few bugs.
Changes/New Features in 5.1.19:
S+6 now supported (Tony Rossini (Unix) and Rich Heiberger (Windows))
New BUGS support through ESS[BUGS] mode (Rodney Sparapani) Templates assist you in writing .bug and .cmd code (.cmd and .log are replaced by .bmd and .bog to avoid emacs extension collisions). Substitution" parameters facilitate "automagic" generation of data...in" and "init...in" filenames, "const N=" from your data file and "monitor()/stats()" commands. Activated by pressing F12.
Fixes for `ess-smart-underscore' SAS breakage (Rich Heiberger)
You can change between PC and Unix, local and global SAS function-key definitions interactively (Rich Heiberger)
C-Submit a highlighted region to SAS batch (Rodney Sparapani)
New and improved SAS syntax highlighting (Rodney Sparapani) To get the new functionality, set ess-sas-run-make-regexp to nil. Also available in .log files via F10.
Open a permanent SAS dataset for viewing via F9 (Rodney Sparapani) You must have the library defined in autoexec.sas for it to work.
User-friendly defaults for `sas-program', `ess-sas-batch-pre-command' and `ess-sas-batch-post-command' as well Customize support for these and other ESS[SAS] variables (Rodney Sparapani)
`ess-sas-suffix-2' now defaults to .dat via F11 (Rodney Sparapani)
Emacs/XEmacs, Unix/Windows issues collectively handled in ess-emcs.el
defadvice solves problem of missing *ESS* (thanks to Jeff Mincy)
Improved manual a bit by including things that were only in `README'.
Changes/New Features in 5.1.18:
New `ess-smart-underscore' function, now assigned to "_" by default. Inserts `ess-S-assign' (customizable " <- "), unless inside string and comments where plain "_" is used instead. (MM)
Fixes for longstanding interactive SAS breakage (RMH)
Changes/New Features in 5.1.17:
Documentation for Windows Installation (Rich Heiberger)
removal of ess-vars, finalization of customize support (in the sense that there is no more use of ess-vars, but that we need to fix ess-cust) (AJ Rossini)
Many small (and large) fixes/contributions (MMaechler)
addition of the "S-equal" variable and provide M-x ess-add-MM-keys a way to remap "_" to `ess-S-assign', typically " <- ", but customizable. (MMaechler)
Changes/New Features in 5.1.16:
BUG FIXES
Better SAS support
Changes/New Features in 5.1.15:
BUG FIXES
Changes/New Features in 5.1.14:
Yet more fixes to SAS mode, (Rich Heiberger and Rodney Sparapani)
Customize support (for most Emacsen which support it) (AJRossini)
ARC and ViSta support out of the box, and fixes for XLispStat (AJRossini)
Changes/New Features in 5.1.13:
Version numbering finally all depending on the ./VERSION file, thanks to Martin Maechler.
Yet more fixes to SAS mode, thanks to Rich Heiberger.
Changes/New Features in 5.1.12:
Splus 5.1 stabilized, thanks to Martin Maechler, Bill Venables, Chuck Taylor, and others.
More fixes to SAS mode, thanks to Rodney Sparapani and Rich Heiberger.
Changes/New Features in 5.1.11:
More fixes to Stata mode, thanks to Brendan Halpin.
fixed bugs in ESS-elsewhere, thanks to many testers
README.SPLUS4WIN has DETAILED instructions for S-PLUS 2000, thanks to David Brahm.
Fixes to SAS mode, thanks to Rodney Sparapani
Changes/New Features in 5.1.10:
More fixes to Stata mode
primitive generic version of ESS-elsewhere
Small fixes to SAS/Stata.
Changes/New Features in 5.1.9:
Stata mode works
Literate Data Analysis using Noweb works
Changes/New Features in 5.1.8:
Bug fixes
R documentation mode defaults changed
Changes/New Features in 5.1.2:
able to use inferior iESS mode to communicate directly with a running S-Plus 4.x process using the Microsoft DDE protocol. We use the familiar (from Unix ESS) C-c C-n and related key sequences to send lines from the S-mode file to the inferior S process. We continue to edit S input files in ESS[S] mode and transcripts of previous S sessions in ESS Transcript mode. All three modes know the S language, syntax, and indentation patterns and provide the syntactic highlighting that eases the programming tasks.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The ESS environment is built on the open-source projects of many contributors, dating back nearly 15 years. Doug Bates and Ed Kademan wrote S-mode in 1989 to edit S and Splus files in GNU Emacs. Frank Ritter and Mike Meyer added features, creating version 2. Meyer and David Smith made further contributions, creating version 3. For version 4, David Smith provided process interaction based on Olin Shivers' comint package.
John Sall wrote GNU Emacs macros for SAS source code around 1990. Tom Cook added more functionality creating SAS-mode which was distributed in 1994. Also in 1994, A.J. Rossini extended S-mode to support XEmacs. Together with extensions written by Martin Maechler, this became version 4.7 and supported S, Splus, and R. In 1995, Rossini extended SAS-mode to work with XEmacs.
In 1997, Rossini merged S-mode and SAS-mode into a single Emacs package for statistical programming; the product of this marriage was called ESS version 5.
The multiple process code, and the idea for
ess-eval-line-and-next-line
are by Rod Ball.
Thanks to Doug Bates for many useful suggestions.
Thanks to Martin Maechler for reporting and fixing bugs, providing many useful comments and suggestions, and for maintaining the S-mode mailing list.
Thanks to Frank Ritter for updates from the previous version, the menu code, and invaluable comments on the manual.
Thanks to Ken'ichi Shibayama for his excellent indenting code, and many comments and suggestions.
Last but definitely not least, thanks to the many beta testers of the S-mode and ESS mailing lists.
ESS version 5 is being developed and currently maintained by
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The latest version of ESS is always available on the web at: ESS web page or StatLib
There no longer is an anonymous CVS repository for ESS, due to lack of interest, little demand, and problems with security.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
If you need to install ESS, read Installing ESS on your system for details on what needs to be done before proceeding to the next chapter.
In this manual we use the standard notation for describing the keystrokes used to invoke certain commands. C-<chr> means hold the CONTROL key while typing the character <chr>. M-<chr> means hold the META or EDIT or ALT key down while typing <chr>. If there is no META, EDIT or ALT key, instead press and release the ESC key and then type <chr>.
All ESS commands can be invoked by typing M-x command. Most of the useful commands are bound to keystrokes for ease of use. Also, the most popular commands are also available through the emacs menubar, and finally, if available, a small subset are provided on the toolbar. Where possible, keybindings are similar to other modes in emacs to strive for a consistent user interface within emacs, regardless of the details of which programming language is being edited, or process being run.
Some commands, such as M-x R can accept an optional `prefix' argument. To specify the prefix argument, you would type C-u before giving the command. e.g. If you type C-u M-x R, you will be asked for command line options that you wish to invoke the R process with.
Emacs is often referred to as a `self-documenting' text editor. This applies to ESS in two ways. First, limited documentation about each ESS command can be obtained by typing C-h f. For example, if you type C-h f ess-eval-region, documentation for that command will appear in a separate *Help* buffer. Second, a complete list of keybindings that are available in each ESS mode and brief description of that mode is available by typing C-h m within an ESS buffer.
Emacs is a versatile editor written in both C and lisp; ESS is written in the Emacs lisp dialect (termed `elisp') and thus benefits from the flexible nature of lisp. In particular, many aspects of ESS behaviour can be changed by suitable customization of lisp variables. This manual mentions some of the most frequent variables. A full list of them however is available by using the Custom facility within emacs. (Type M-x customize-group RET ess RET to get started.) Customizing ESS provides details of common user variables you can change to customize ESS to your taste, but it is recommended that you defer this section until you are more familiar with ESS.
[ << ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
This document was generated by Rodney Sparapani on June, 30 2004 using texi2html 1.70.