Microsoft Windows installation
==============================

For Microsoft Windows installation, please follow the next steps. Retrieve the latest zip file (ess-VERSION.zip) from ESS downloads area (http://ess.r-project.org/index.php?Section=download).

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 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-request@stat.math.ethz.ch 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-request@stat.math.ethz.ch 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.