Previous: (dir), Up: (dir)

1 General Information: README

This is the README file for the distribution of ESS version

12.03

ESS is a GNU Emacs and XEmacs mode for interactive statistical programming and data analysis. Languages supported: the S family (S, S-PLUS and R), SAS, BUGS/JAGS, Stata and XLispStat. 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.

Installation instructions are provided in sections for both Unix and Windows; see below.

The current development team is led by Martin Maechler since August 2004. Former project leader A.J. (Tony) Rossini (rossini@blindglobe.net) did the initial port to XEmacs and has been the primary coder. Martin Maechler (maechler@stat.math.ethz.ch) and Kurt Hornik (Kurt.Hornik@R-project.org) have assisted with the S family and XLispStat. Stephen Eglen (stephen@gnu.org) has worked mostly on R support. Richard M. Heiberger (rmh@temple.edu) has assisted with S/S-PLUS development for Windows. Richard and Rodney A. Sparapani (rsparapa@mcw.edu) have done much of the work improving SAS batch and interactive support. Rodney has also extended ESS to support BUGS/JAGS and has an interest in improving Stata 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).

Next: , Previous: General Information, Up: General Information

1.1 License

The source and documentation of 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.

Next: , Previous: License, Up: General Information

1.2 Stability

All recent released versions are meant to be release-quality versions. While some new features are being introduced, we are cleaning up and improving the interface. We know that there are many remaining opportunities for documentation improvements, but all contributors are volunteers and time is precious. Patches or suggested fixes with bug reports are much appreciated!

Next: , Previous: Stability, Up: General Information

1.3 Requirements

ESS is most likely to work with current/recent versions of the following statistical packages: R/S-PLUS, SAS, Stata, OpenBUGS and JAGS.

ESS supports current, and recent, stable versions of GNU Emacs (specifically, the 22.x and 23.x series; alpha/beta/pre-release versions are NOT SUPPORTED). XEmacs is currently NOT SUPPORTED, but ESS v. 5.14 should still work (XEmacs stable 21.4.14 or higher).

To build the PDF documentation, you will need a version of TeX Live or texinfo that includes texi2dvi (BEWARE: recent TeX Live, and some texinfo RPMs, do NOT include texi2dvi).

Next: , Previous: Requirements, Up: General Information

1.4 Getting the Latest Version

The latest released version of ESS is always available on the web at: ESS web page or StatLib

The latest development version of ESS is available via https://svn.R-project.org/ESS/, the ESS Subversion repository. If you have a Subversion client (see http://subversion.tigris.org/), you can download the sources using: 

     % svn checkout https://svn.r-project.org/ESS/trunk path

which will put the ESS files into directory path. Later, within that directory, `svn update' will bring that directory up to date. Windows-based tools such as TortoiseSVN are also available for downloading the files. Alternatively, you can browse the sources with a web browser at: ESS SVN site. However, please use a subversion client instead to minimize the load when retrieving.

If you remove other versions of ESS from your emacs load-path, you can then use the development version by adding the following to .emacs: 

     (load "/path/to/ess-svn/lisp/ess-site.el")

Note that https is required, and that the SSL certificate for the Subversion server of the R project is 

     Certificate information:
      - Hostname: svn.r-project.org
      - Valid: from Jul 16 08:10:01 2004 GMT until Jul 14 08:10:01 2014 GMT
      - Issuer: Department of Mathematics, ETH Zurich, Zurich, Switzerland, CH
      - Fingerprint: c9:5d:eb:f9:f2:56:d1:04:ba:44:61:f8:64:6b:d9:33:3f:93:6e:ad

(currently, there is no “trusted certificate”). You can accept this certificate permanently and will not be asked about it anymore.

Next: , Previous: Latest Version, Up: General Information

1.5 Installation

Next: , Up: Installation

1.6 Unix installation

For a Unix or Unix-like installation, please follow the next steps. Retrieve the latest tgz file (ess-VERSION.tgz) from ESS downloads area.

GNU Emacs Simple Instructions: for recent versions of Emacs (22.x or higher) and ESS, the installation process is simple.

  1. Extract all the files from ess-VERSION.tgz into the directory PREFIX/site-lisp where PREFIX is appropriate for GNU Emacs on your system; PREFIX will most likely be either /usr/share/emacs or /usr/local/share/emacs (on Mac OS X, PREFIX will most likely be something like /Applications/Emacs.app/Contents/Resources): 
              GNU tar  % gtar zxf ess-VERSION.tgz -C PREFIX/site-lisp
          Unix tar % gunzip < ess-VERSION.tgz | tar xf - -C PREFIX/site-lisp
  2. Then, add the line 
              (require 'ess-site)

    to ~/.emacs and restart Emacs.

  3. If you see a buffer named *ESS*, then the simple instructions were most likely successful. If not, then read further.
  4. It could be that you have an older version of Emacs, some other problem with your installation or you are not a sysadmin. Whatever the case, you may need to edit ess-site.el manually. If that is the case, then you should create a directory just for ESS like ~/ess or /usr/local/ess and unpack ESS there. That way, your changes to ess-site.el will not be lost if you update Emacs later.
  5. Replace the line above with 
              (load "~/ess/ess-VERSION/lisp/ess-site")

    in ~/.emacs and restart Emacs.

  6. If you see a buffer named *ESS*, then the manual instructions were most likely successful. If not, then send a query to ess-help@r-project.org explicitly describing your problem and your environment including operating system, Emacs version, ESS version, etc.

XEmacs Simple Instructions: for recent versions of XEmacs (21.x or higher) and ESS, the installation process is simple.

  1. Extract all the files from ess-VERSION.tgz when you are in the current working directory of /usr/local/LOCATION/xemacs/site-packages which exists for packages like ESS where LOCATION is lib for legacy installations and share now (and for Mac OS X create a link to it from the directory /Applications/XEmacs.app/Contents/Resources/site-lisp): 
              %prompt gtar zxf ess-VERSION.tgz            # for GNU tar
          %prompt gunzip < ess-VERSION.tgz | tar xf - # for Unix tar
  2. Then, add the line 
              (require 'ess-site)

    to ~/.xemacs/init.el and restart XEmacs.

  3. If you see a buffer named *ESS*, then the simple instructions were most likely successful. If not, then read further.
  4. It could be that you have an older version of XEmacs, some other problem with your installation or you are not a sysadmin. Whatever the case, you may need to edit ess-site.el manually. If that is the case, then you should create a directory just for ESS like ~/ess or /usr/local/ess and unpack ESS there. That way, your changes to ess-site.el will not be lost if you update XEmacs later.
  5. Replace the line above with 
              (load "~/ess/ess-VERSION/lisp/ess-site")

    in ~/.xemacs/init.el and restart XEmacs.

  6. If you see a buffer named *ESS*, then the manual instructions were most likely successful. If not, then send a query to ess-help@r-project.org explicitly describing your problem and your environment including operating system, XEmacs version, ESS version, etc.
  1. (OPTIONAL) COMPILING E-LISP:

    Edit the default locations of LISPDIR, INFODIR and ETCDIR in Section 1 of Makeconf (if you are using XEmacs, then edit the XEmacs subsection in Section 1).

    You can compile those files by: 

              make all

    When that completes successfully, install the compiled files: 

              make install

Next: , Previous: Unix installation, Up: Installation

1.7 Microsoft Windows installation

For Microsoft Windows installation, please follow the next steps. Retrieve the latest zip file (ess-VERSION.zip) from ESS downloads area.

GNU Emacs Simple Instructions: for recent versions of Emacs (22.x or higher) and ESS, the installation process is simple.

  1. Extract all the files from ess-VERSION.zip (by double clicking on it and selecting “Extract all files” which launches the Folders Extraction Wizard) into an ESS sub-directory of the site-lisp directory that exists for packages like ESS. If GNU Emacs was installed in the default location, then this directory can be found somewhere like C:\Program Files\GNU Emacs\emacs-22.x\site-lisp
  2. Add the line 
              (require 'ess-site)

    to ~/.emacs and restart Emacs.

  3. If you see a buffer named *ESS*, then the simple instructions were most likely successful. If not, then read further.
  4. It could be you have an older version of Emacs or some other problem with your installation. Either way, you may need to edit C:\ess\ess-VERSION\lisp\ess-site.el manually. If that is the case, then you should create a directory just for ESS like C:\ess and unpack ESS there. That way, your changes to C:\ess\ess-VERSION\lisp\ess-site.el will not be lost if you update Emacs later.
  5. Replace the line above with 
              (load "C:/ess/ess-VERSION/lisp/ess-site")

    in ~/.emacs and restart Emacs.

  6. If you see a buffer named *ESS*, then the manual instructions were most likely successful. If not, then send a query to ess-help@r-project.org explicitly describing your problem and your environment including operating system, Emacs version, ESS version, etc.

XEmacs Simple Instructions: for recent versions of XEmacs (21.x or higher), the installation process is much simpler. Hopefully, these simple instructions will work for you. If not, then more detailed, manual instructions follow.

  1. Extract all the files from ess-VERSION.zip (by double clicking on it and selecting “Extract all files” which launches the Folders Extraction Wizard) into the site-packages directory that exists for packages like ESS. If XEmacs was installed in the default location, then this directory can be found at C:\Program Files\XEmacs\site-packages.
  2. XEmacs requires the HOME environment variable to be defined. You can create it by visiting the following dialog: My Computer->Control Panel->System->Advanced->Environment Variables In the User variables window, press New. And create a variable named HOME with a value something like (you must use forward slashes / rather than backslashes \) c:/Documents and Settings/%USERNAME%/Application Data. Then press OK for that window and press OK for the main window. If you also have GNU Emacs installed, GNU Emacs will recognize HOME and expand ~ accordingly.
  3. Now launch XEmacs and do a C-x C-f followed by a ~. From the Subdir menu, select Create Directory, and enter .xemacs
  4. Add the line 
              (require 'ess-site)

    to ~/.xemacs/init.el and restart XEmacs.

  5. If you see a buffer named *ESS*, then the simple instructions were most likely successful. If not, then read further.
  6. It could be you have an older version of XEmacs or some other problem with your installation. Either way, you may need to edit C:\ess\ess-VERSION\lisp\ess-site.el manually. If that is the case, then you should create a directory just for ESS like C:\ess and unpack ESS there. That way, your changes to C:\ess\ess-VERSION\lisp\ess-site.el will not be lost if you update XEmacs later.
  7. Replace the line above with 
              (load "C:/ess/ess-VERSION/lisp/ess-site")

    in ~/.xemacs/init.el and restart XEmacs.

  8. If you see a buffer named *ESS*, then the manual instructions were most likely successful. If not, then send a query to ess-help@r-project.org explicitly describing your problem and your environment including operating system, XEmacs version, ESS version, etc.

Now, you should be ready to use ESS. For example, 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). One further step is needed if you wish to run statistical processes, see below.

To run statistical processes under ESS, 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 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 as this may cause problems. Also, make sure to use backslashes \ since Windows requires them.

An alternative, for R users, is that rather than adjusting the PATH variable, you can add the following to your emacs initialization file (and restart emacs): 

     (setq inferior-R-program-name "c:/progra~1/R/R-2.2.1/bin/Rterm.exe")

This assumes that you have installed R-2.2.1 in the default location. Change the path otherwise to point to other locations.

Windows users who place S-PLUS anywhere other than the default location will also need to add the following three lines (properly adjusted for their location): 

     (setq-default inferior-S+6-program-name
         "c:/progra~1/Insightful/SPLUS70/cmd/Splus")
     (setq-default inferior-Sqpe+6-SHOME-name
         "c:/progra~1/Insightful/SPLUS70")
     (setq-default inferior-Sqpe+6-program-name
         "c:/progra~1/Insightful/SPLUS70/cmd/Sqpe.exe")

The above example uses the default location of S-PLUS in c:\progra~1\Insightful. Please note that ESS considers S-PLUS 6, 7, and 8 to be variants of S+6.

These users may also need to modify the emacs variable ess-SHOME-versions to match their installation in order to get the full set of S-PLUS versions on their machine into the ESS menu.

To start the S-PLUS [678].x GUI from ESS under emacs:

  1. If you use Cygwin bash as your primary shell, then 
              M-x S
          (or M-x S+6).
  2. If you use the MSDOS prompt window as your primary shell, then 
              M-x S+6-msdos
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 or M-x S+4-msdos.)

To start an S-PLUS [678].x session inside an emacs buffer—and without the S-PLUS GUI: 

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

This works with both the bash and msdos shells. 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

or 

     M-x S+6-msdos-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 or M-x S+4-msdos-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.

Next: , Previous: Installation, Up: General Information

1.8 Starting an ESS process

To start an S session on Unix or on Windows when you use the Cygwin bash shell, simply type M-x S RET.

To start an S session on Windows when you use the MSDOS prompt shell, simply type M-x S+6-msdos RET.

Next: , Previous: Starting up, Up: General Information

1.9 Current Features

Next: , Previous: Current Features, Up: General Information

1.10 New Features

Next: , Previous: New Features, Up: General Information

1.11 Reporting Bugs

Please send bug reports, suggestions etc. to ESS-bugs@stat.math.ethz.ch

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.

Next: , Previous: Reporting Bugs, Up: General Information

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

Previous: Mailing Lists, Up: General Information

1.13 Authors