[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1. General Information: README

This is the README file for the distribution of ESS version

5.2.1

The first release of the 5.2 series. ESS is a GNU Emacs and XEmacs mode for interactive statistical programming and data analysis. Languages supported: the S family (S 3/4, S-PLUS 3/4/5/6, and R), SAS, XLispStat, Stata and BUGS. Installation help can be found in sections for both Unix and Windows. ESS grew out of the desire for bug fixes and extensions to S-mode and SAS-mode as well as a consistent union of their features in one package.

The current development team is led by A.J. (Tony) Rossini (rossini@biostat.washington.edu), who did the initial port to XEmacs and has been the primary coder. Martin Maechler (maechler@stat.math.ethz.ch) and Kurt Hornik (hornik@ci.tuwien.ac.at) have assisted with S-PLUS, S4, R, and XLispStat. Richard M. Heiberger (rmh@temple.edu) has assisted with S-PLUS and S4 development for Windows. Richard and Rodney A. Sparapani (rsparapa@mcw.edu) have done much of the work implementing interactive SAS (iESS[SAS]) and batch SAS (ESS[SAS]) support.

We are grateful to the previous developers of S-mode (Doug Bates, Ed Kademan, Frank Ritter, David M. Smith), SAS-mode (Tom Cook) and Stata-mode (Thomas Lumley).

1.1 License  
1.2 New Features  
1.3 Current Features  
1.4 Stability  
1.5 Requirements  
1.6 Getting the Latest Version  
1.7 Installation (from tar file)  
1.11 Reporting Bugs  
1.12 Mailing Lists  
1.13 Authors  
[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.1 License

ESS is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version.

ESS is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License in the file COPYING in the same directory as this file for more details.

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.2 New Features

Changes/New Features in 5.2.1:

Changes/New Features in 5.2.0:

Changes/New Features in 5.1.24:

Changes/New Features in 5.1.23:

Changes/New Features in 5.1.22:

Changes/New Features in 5.1.21:

Changes/New Features in 5.1.20:

Changes/New Features in 5.1.19:

Changes/New Features in 5.1.18:

Changes/New Features in 5.1.17:

Changes/New Features in 5.1.16:

Changes/New Features in 5.1.15:

Changes/New Features in 5.1.14:

Changes/New Features in 5.1.13:

Changes/New Features in 5.1.12:

Changes/New Features in 5.1.11:

Changes/New Features in 5.1.10:

Changes/New Features in 5.1.9:

Changes/New Features in 5.1.8:

Changes/New Features in 5.1.2:

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.3 Current Features

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.4 Stability

Versions 5.1.x are meant to be gamma-level releases. While some bugs are fixed, others may have been introduced, especially with regards to new features. See the file doc/TODO for details. Bug reports are solicited; see the Bugs Section below. Patches or suggested coding fixes with bug reports are much appreciated!

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.5 Requirements

ESS has been tested with

on the following platforms

with the following versions of emacs

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.6 Getting the Latest Version

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] [ ? ]

1.7 Installation (from tar file)

We now discuss installation, which might happen under Unix or Microsoft Windows. First, we discuss Unix installation. See section Unix installation.

For Microsoft Windows Installation please skip to the See section Microsoft Windows installation.

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.8 Unix installation

  1. cd to a directory where you want to install ESS, creating it if necessary. This directory will be referred to below as ESSDIR.

  2. Retrieve the latest version from gzipped tar file to ESSDIR.

  3. Decompress/unarchive the files from the disribution.

     
    gunzip ess-VERSION.tar.gz
tar xvf ess-VERSION.tar
     
    (or: gunzip < ess-VERSION.tar.gz | tar xvf - ).
(or using GNU tar:  tar zxvf ess-VERSION.tar.gz).

    The tar command will create the subdirectory ess-VERSION and unarchive the files there.

    If you are using GNU Emacs 19.29, decompress/unarchive `ESSDIR/ess-VERSION/lisp/19.29.tar.gz', read `ESSDIR/ess-VERSION/lisp/19.29/README', follow the instructions and you might be able to get ESS to work. Please note that GNU Emacs 19.29 is no longer supported. For a list of supported versions of emacs, see See section Requirements.

  4. Edit the file `ESSDIR/ess-VERSION/lisp/ess-site.el' as explained in the comments section of that file.

  5. Add the line

     
    (load "ESSDIR/ess-VERSION/lisp/ess-site")

    to your user or system installation file (GNU Emacs uses `$HOME/.emacs' and XEmacs uses `$HOME/.xemacs/init.el' for the user initialization file. GNU Emacs uses default.el or site-init.el and XEmacs uses site-start.el for the system installation file).

    Alternatively, if ess-site.el is in your current Lisp path, you can do:

     
    (require 'ess-site)

    to configure emacs for ESS.

  6. That's it! To edit statistical programs, load the files with the requiste extensions (".sas" for SAS, ".S" for S-PLUS, ".R" for R, and ".lsp" for XLispStat).

  7. (OPTIONAL) If you are running S-PLUS or R, you might consider installing the database files. From within emacs, C-x d to the directory containing ESS. Now:

     
    M-x S+6

    to get S running. Once you see the SPLUS prompt, do:

     
    M-x ess-create-object-name-db

    (this will create the file `ess-s+6-namedb.el'; if it isn't in the ESS directory, move it there).

    Then, completions will be autoloaded and will not be regenerated for every session.

    For R, do the same, using

     
    M-x R

    and then M-x ess-create-object-name-db creating `ess-r-namedb.el'; if it isn't in the ESS directory, move it there).

  8. (OPTIONAL) READ THIS ITEM THOROUGHLY BEFORE STARTING:

    If you want to place the compiled files in other locations edit the LISPDIR and INFODIR entries in `Makeconf' in the ESSDIR/ess-VERSION directory (if you are using XEmacs, then you also need to edit the EMACS entry as follows: EMACS=xemacs).

    You can compile those files by:

     
    make all

    When that completes successfully, install the compiled files:

     
    make install

    This will install the compiled info files and lisp files. If you are an XEmacs user, then you should be done. If not, then you may have to edit/create the file `dir' that is found in the directory specified by INFODIR: see the sample `dir' in ESSDIR/ess-VERSION/doc/info. If `dir' does not exist in INFODIR, then the sample `dir' will be installed.

    Note 1: It is assumed that GNU make will be used; otherwise, edit the ESSVERSION and ESSVERSIONTAG entries in `Makeconf' appropriately, e.g.: ESSVERSION=5.2.0 and ESSVERSIONTAG=ESS-5-2-0

    Note 2: ESS can be installed for XEmacs as an XEmacs package much more easily than what has been described anywhere above. However, the latest ESS version will not be available at the same time as an XEmacs package; generally, it can take weeks or months to appear in the latter format. For more information on installing ESS as an XEmacs package see Quickstart Package Guide.

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.9 Microsoft Windows installation

For Microsoft Windows installation, please follow the next steps: (see separate instructions above for UNIX See section Unix installation.

  1. cd to a directory where you keep emacs lisp files, or create a new directory (for example, `c:\emacs\') to hold the distribution. This directory will be referred to below as "the ESS distribution directory". It will contain, at the end, either the tar file `ess-VERSION.tar.gz' or the zip file `ess-VERSION.zip', and a directory for the ESS source, which will be termed "the ESS-VERSION source directory".

  2. Retrieve the compressed tar file `ess-VERSION.tar.gz' or the zipped file `ess-VERSION.zip' from one of the FTP or WWW archive sites via FTP (or HTTP). Be aware that http browsers on Windows frequently change the "." and "-" characters in filenames to other punctuation. Please change the names back to their original form.

  3. Copy `ess-VERSION.tar.gz' to the location where you want the ess-VERSION directory, for example to `c:\emacs\ess-VERSION.tar.gz', and cd there. For example,

     
    cd c:\emacs

    Extract the files from the distribution, which will unpack into a subdirectory, `ess-VERSION'.

     
    gunzip ess-VERSION.tar.gz
tar xvf ess-VERSION.tar
(or: gunzip < ess-VERSION.tar.gz | tar xvf - ).
(or: from the zip file: unzip ess-VERSION.zip)

    The tar command will extract files into the current directory.

    Do not create `ess-VERSION' yourself, or you will get an extra level of depth to your directory structure.

  4. Windows users will usually be able to use the `lisp/ess-site.el' as distributed. Only rarely will changes be needed.

  5. Windows users will need to make sure that the directories for the software they will be using is in the PATH environment variable. On Windows 9x, add lines similar to the following to your `c:\autoexec.bat' file:

     
    path=%PATH%;c:\progra~1\spls2000\cmd

    On Windows NT/2000/XP, add the directories to the PATH using the My Computer/Control Panel/System/Advanced/Environment Variables menu. Note that the directory containing the program is added to the PATH, not the program itself. One such line is needed for each software program. Be sure to use the abbreviation progra~1 and not the long version with embedded blanks. Use backslashes "\".

  6. Add the line

     
    (load "/PATH/ess-site")

    to your .emacs (or _emacs) file (or default.el or site-init.el, for a site-wide installation). Replace /PATH above with the value of ess-lisp-directory as defined in `ess-site.el'. Use forwardslashes /. (GNU Emacs uses the filename `%HOME%/.emacs' and XEmacs uses the filename `%HOME%/.xemacs/init.el' for the initialization file.)

  7. To edit statistical programs, load the files with the requisite extensions (".sas" for SAS, ".S" or "s" or "q" or "Q" for S-PLUS, ".r" or ".R" for R, and ".lsp" for XLispStat).

  8. To run statistical processes under emacs:

    To start the S-PLUS 6.x GUI from ESS under emacs:

     
    M-x S
(or M-x S+6).

    You will then be asked for a pathname ("S starting data directory?"), from which to start the process. The prompt will propose your current directory as the default. ESS will start the S-PLUS GUI. There will be slight delay during which emacs is temporarily frozen. ESS will arrange for communication with the S-PLUS GUI using the DDE protocol. Send lines or regions from the emacs buffer containing your S program (for example, `myfile.s') to the S-PLUS Commands Window with the C-c C-n or C-c C-r keys. (If you are still using S-PLUS 4.x or 2000, then use M-x S+4.)

    To start an S-PLUS 6.x session inside an emacs buffer--and without the S-PLUS GUI:

     
    M-x Sqpe
(or M-x Sqpe+6).

    You will then be asked for a pathname ("S starting data directory?"), from which to start the process. The prompt will propose your current directory as the default. You get Unix-like behavior, in particular the entire transcript is available for emacs-style search commands. Send lines or regions from the emacs buffer containing your S program (for example, `myfile.s') to the *S+6* buffer with the C-c C-n or C-c C-r keys. Interactive graphics are available with Sqpe by using the java library supplied with S-PLUS 6.1 and newer releases. Enter the commands:

     
    library(winjava)
java.graph()

    Graphs can be saved from the java.graph device in several formats, but not PostScript. If you need a PostScript file you will need to open a separate postscript device. (If you are still using S-PLUS 4.x or 2000, then use M-x Sqpe+4.)

    To connect to an already running S-PLUS GUI (started, for example, from the S-PLUS icon):

     
    M-x S+6-existing

    You will then be asked for a pathname ("S starting data directory?"), from which to start the process. The prompt will propose your current directory as the default. ESS will arrange for communication with the already running S-PLUS GUI using the DDE protocol. Send lines or regions from the emacs buffer containing your S program (for example, `myfile.s') to the S-PLUS Commands Window with the C-c C-n or C-c C-r keys. (If you are still using S-PLUS 4.x or 2000, then use M-x S+4-existing.)

    If you wish to run R, you can start it with:

     
    M-x R

    XLispStat can not currently be run with

     
    M-x XLS

    Hopefully, this will change. However, you can still edit with emacs, and cut and paste the results into the XLispStat *Listener* Window under Microsoft Windows.

    SAS for Windows uses the batch access with function keys that is described in @xref{ESS(SAS)--MS Windows}. The user can also edit SAS files in an ESS[SAS] buffer and than manually copy and paste them into an Editor window in the SAS Display Manager.

    For Windows, inferior SAS in an iESS[SAS] buffer does not work on the local machine. It does work over a network connection to SAS running on a remote Unix computer.

    Reason: we use ddeclient to interface with programs and SAS doesn't provide the corresponding ddeserver capability.

  9. (OPTIONAL) If you are running Sqpe or R, you might consider installing the database files. From within emacs, C-x d to the directory containing ESS. Now:

     
    M-x Sqpe+6

    to get S running. Once you see the SPLUS prompt, do:

     
    M-x ess-create-object-name-db

    (this will create the file `ess-s+6-namedb.el'; if it isn't in the ESS directory, move it there).

    Then, completions will be autoloaded and will not be regenerated for every session.

    For R, do the same, using

     
    M-x R

    and then M-x ess-create-object-name-db creating `ess-r-namedb.el'; if it isn't in the ESS directory, move it there).

  10. That's it!

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.10 Requirements

ESS has been tested with

on the following platforms

with the following versions of emacs

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.11 Reporting Bugs

Please send bug reports, suggestions etc. to

<A HREF="mailto:ESS-bugs@stat.math.ethz.ch"> ESS-bugs@stat.math.ethz.ch </A>

The easiest way to do this is within Emacs by typing

M-x ess-submit-bug-report

This also gives the maintainers valuable information about your installation which may help us to identify or even fix the bug.

If Emacs reports an error, backtraces can help us debug the problem. Type "M-x set-variable RET debug-on-error RET t RET". Then run the command that causes the error and you should see a *Backtrace* buffer containing debug information; send us that buffer.

Note that comments, suggestions, words of praise and large cash donations are also more than welcome.

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.12 Mailing Lists

There is a mailing list for discussions and announcements relating to ESS. Join the list by sending an e-mail with "subscribe ess-help" (or "help") in the body to ess-help-request@stat.math.ethz.ch; contributions to the list may be mailed to ess-help@stat.math.ethz.ch. Rest assured, this is a fairly low-volume mailing list.

The purposes of the mailing list include

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.13 Authors

[Top] [Contents] [Index] [ ? ]

Footnotes

(1)

requires the files.el patch to revert-buffer for the Local Variables updating problem

(2)

These releases of emacs are no longer supported, so an upgrade is recommended if you plan to use ESS. If you have GNU Emacs 19.29, see See section Unix installation. Also, note that the `custom' library bundled with Emacs 19.34 is too _old_, its API is incompatible with the `new custom' bundled with recent Emacsen. The `new custom' for Emacs 19.34 is available for download here.

(3)

requires the files.el patch to revert-buffer for the Local Variables updating problem

(4)

These releases of emacs are no longer supported, so an upgrade is recommended if you plan to use ESS. If you have GNU Emacs 19.29, see See section Unix installation. Also, note that the `custom' library bundled with Emacs 19.34 is too _old_, its API is incompatible with the `new custom' bundled with recent Emacsen. The `new custom' for Emacs 19.34 is available for download here.

[Top] [Contents] [Index] [ ? ]

About This Document

This document was generated by Rodney Sparapani on June, 30 2004 using texi2html 1.70.

The buttons in the navigation panels have the following meaning:

Button Name Go to From 1.2.3 go to
[ < ] Back previous section in reading order 1.2.2
[ > ] Forward next section in reading order 1.2.4
[ << ] FastBack beginning of this chapter or previous chapter 1
[ Up ] Up up section 1.2
[ >> ] FastForward next chapter 2
[Top] Top cover (top) of document  
[Contents] Contents table of contents  
[Index] Index index  
[ ? ] About about (help)  

where the Example assumes that the current position is at Subsubsection One-Two-Three of a document of the following structure:

This document was generated by Rodney Sparapani on June, 30 2004 using texi2html 1.70.