[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
The following section details those steps necessary to get ESS running on your system.
A.1 Unix installation A.2 Microsoft Windows installation A.3 Other variables you may need to change
We now discuss installation, which might happen under Unix or Microsoft Windows. First, we discuss Unix installation. See section A.1 Unix installation.
For Microsoft Windows Installation please skip to the See section A.2 Microsoft Windows installation.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
Note that the .elc files may be installed elsewhere (as specified in the Makefile) if desired.
gunzip ess-5.1.20.tar.gz tar vxf ess-5.1.20.tar |
gunzip < ess-5.1.20.tar.gz | tar vxf -
).
(or using GNU tar: tar zvxf ess-5.1.20.tar.gz
).
The tar
command will extract files into the current directory.
Do not create ess-5.1.20 yourself, or you will get an extra level of
depth to your directory structure.
Note if you have a very ancient version of GNU emacs (and really can not upgrade to Emacs 20 or higher!) you can unpack the `lisp/19.29.tar.gz' file, read the ensuing `lisp/19.29/README' and you may succeed...
In the ess-5.1.20 directory, edit the file `Makeconf' (only if you want to place the executables in other locations; see LISPDIR and INFODIR) and then type:
make |
If this works, then you might try:
make install |
This will install the info files (and the lisp files, if they are to go
in another directory). Don't forget to edit the file `dir' in the
info directory specified by INFODIR
in `doc/Makefile'. See
the sample `dir' file for an example of the line to add.
If you are using XEmacs, you might do:
make EMACS=xemacs |
and then
make EMACS=xemacs install |
Note that you might need to use GNU make for everything to work properly
An alternative, if you are running XEmacs and have access to the
XEmacs system directories, would be to place the directory in the
site-lisp directory, and simply type make
(and copy the
documentation as appropriate).
For Emacs, you would still have to move the files into the top level site-lisp directory.
(load "/PATH/ess-site") |
Alternatively, if ess-site.el is in your current Lisp path, you can do:
(require 'ess-site) |
C-x d
to the
directory containing ESS. Now:
M-x S+6 |
M-x S+5
: get running. once you have reached the SPLUS
prompt, do:)
M-x ess-create-object-name-db |
Then, completions will be autoloaded and will not be regenerated for every session.
For R, do the same, using
M-x R |
M-x ess-create-object-name-db
creating
`ess-r-namedb.el'; if it isn't in the ESS directory, move it there).
For the impatient, the quick version of usage follows:
Run S-PLUS 6.x with:
M-x S+6 |
If you wish to run R, you can start it with:
M-x R |
XLispStat can be run with
M-x XLS |
An interactive SAS can be run in an iESS[SAS]
buffer with:
M-x SAS |
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
For Microsoft Windows installation, please follow the next steps: (see separate instructions above for UNIX See section A.1 Unix installation.
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-5.1.20.tar.gz' or the zip file `ess-5.1.20.zip', and a directory for the ESS source, which will be termed "the ESS-5.1.20 source directory".
Retrieve the compressed tar file `ess-5.1.20.tar.gz' or the zipped file `ess-5.1.20.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.
Copy `ess-5.1.20.tar.gz' to the location where you want the ess-5.1.20 directory, for example to `c:\emacs\ess-5.1.20.tar.gz', and cd there. For example,
cd c:\emacs |
Extract the files from the distribution, which will unpack into a subdirectory, `ess-5.1.20'.
gunzip ess-5.1.20.tar.gz tar vxf ess-5.1.20.tar |
gunzip < ess-5.1.20.tar.gz | tar vxf -
).
(or: from the zip file: unzip ess-5.1.20.zip
)
The tar
command will extract files into the current directory.
Do not create `ess-5.1.20' yourself, or you will get an extra level of depth to your directory structure.
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 |
progra~1
and not the long version with embedded blanks. Use
backslashes "\".
Add the line
(load "/PATH/ess-site") |
/PATH
above with the
value of ess-lisp-directory as defined in `ess-site.el'. Use
forwardslashes /
.
(OPTIONAL) If you are running Sqpe or R, you might consider
installing the database files. From within (X)Emacs, C-x d
to
the directory containing ESS. Now:
M-x Sqpe+6 |
M-x ess-create-object-name-db |
Then, completions will be autoloaded and will not be regenerated for every session.
For R, do the same, using
M-x R |
M-x ess-create-object-name-db
creating
`ess-r-namedb.el'; if it isn't in the ESS directory, move it
there).
For more information on using ESS in your daily work, see the files doc/README.SPLUS4WIN, doc/README.S, doc/README.SAS, and doc/README.XLispStat.
For the impatient, the quick version of usage follows:
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).
To run statistical processes under (X)Emacs:
Run S-PLUS 6.x or 2000 with:
M-x S+6 |
M-x S
). 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. Similarly for S-PLUS 6.x. 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.
Run S-PLUS 6.x or 2000 inside an emacs buffer
M-x Sqpe+6 |
C-c C-n
or C-c C-r
keys. You do not have access to
interactive graphics in
this mode. You get Unix-like behavior, in particular the entire
transcript is available for emacs-style search commands.
If you wish to run R, you can start it with:
M-x R |
XLispStat can not currently be run with
M-x XLS |
SAS for Windows uses the batch access with function keys that is
described in `doc/README.SAS'. 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.
[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
If you run the S program (from the shell) with a command other than
`Splus' you will need to set the variable
inferior-ess-program
to the name of the appropriate program by including a line such as
(setq inferior-ess-program "S+") |
If you need to call this program with any arguments, the variable you
need to set is dependent on the value of inferior-ess-program
; for
example if it is "Splus"
, set the variable
inferior-Splus-args
to a string of arguments to the Splus
program. If
inferior-ess-program
has some other value, substitute the
Splus
part of inferior-Splus-args
with the appropriate
program name. There aren't many instances where you need to call S
with arguments, however: in particular do not call the S program
with the `-e' command-line editor argument since ESS provides this
feature for you.
If you are running Splus (the enhanced version of S from Statsci) you
may also need to set the variable S-plus
to t
. If your
value of inferior-ess-program
is "S+"
or Splus
this
will not be necessary, however; S-plus
defaults to t
in
this case.
Finally, if you use a non-standard prompt within S, you will need to set the
variable inferior-ess-prompt
to a regular expression which will match both the primary prompt ("> "
by default) and the continuing prompt (default of "+ "
.) The
default value of this variable matches S's default prompts. For example,
if you use ("$ "
) as your primary prompt (you have
options(prompt="$ ")
in your .First
function), add the
following line to your `.emacs':
(setq inferior-ess-prompt "^\\(\\+\\|[^\\$]*\\$\\) *") |
inferior-ess-primary-prompt
to a regular expression which matches the primary prompt only. Do not
anchor the regexp to the beginning of the line with `^'. Once
again, the default value matches S's default prompt; in the example
above the appropriate value would be "[^\\$]*\\$ *"
.
Once these variables are set appropriately, ESS should work on any system.
[ << ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |