« back to all changes in this revision
Viewing changes to README
- browse files at revision 3
- compare with another revision
- download diff
- download tarball
- view history from revision 3
- Committer: Bazaar Package Importer
- Author(s): Camm Maguire
- Date: 2005-03-22 13:48:07 UTC
- mfrom: (1.2.1 upstream) (2.1.2 hoary)
- Revision ID: james.westby@ubuntu.com-20050322134807-9mpmbb799jugf248
Tags: 5.2.6-1
* New upstream release
* chmod -R u+w on orig source
* chmod -R u+w on orig source
added
removed
README
1
General Information: README
2
***************************
3
4
($Revision: 5.31 $, for ESS version 5.1.20)
5
6
This is the README file for the distribution of ESS version 5.1.20,
7
the gamma series we are using on the way to producing 5.2 (the next
8
stable distribution). ESS is an Emacs-Lisp interface for interactive
9
statistical programming and data analysis. Languages supported include:
10
S dialects (S 3/4, S-PLUS 3.x, and R), LispStat dialects (XLispStat,
11
ViSta), and SAS. Stata and SPSS dialect (SPSS, PSPP) support is being
12
examined for possible future implementation (a preliminary Stata mode is
13
distributed).
14
15
Installation help can be found in sections for Unix Installation or
16
Windows Installion
17
18
For INSTALLATION, see way below.
19
20
ESS grew out of the desire for bug fixes and extensions to
21
S-mode-4.8. In particular, XEmacs support as well as extensions to
22
incorporate R were desired. In addition, with new modes being
23
developed for R, Stata, and SAS, it was felt that providing for a
24
unifying framework would eliminate differences in the user interface,
25
as well as to provide for faster development of production tools and
26
statistical analysis. 5.1.x has, for its guts, the basic framework
27
from S-mode. However, it has been cleaned, streamlined, brought closer
28
to conformance as a standard GNU Emacs package, and redesigned for
29
modularity and reuse.
30
31
The current development team is led by A.J. (Tony) Rossini
32
(<rossini@biostat.washington.edu>), who did the initial port to XEmacs
33
and has been the primary coder. Martin Maechler
34
(<maechler@stat.math.ethz.ch>) and Kurt Hornik
35
(<hornik@ci.tuwien.ac.at>) have assisted with S-PLUS, S4, R, and
36
XLispStat sub-modes, and Richard M. Heiberger
37
(<rmh@fisher.stat.temple.edu>) has assisted with S-PLUS (under MS
38
Windows and remote access) and S4 development. Richard and Rodney
39
Sparapani (<rsparapa@mcw.edu>) have done much of the work for
40
implementing the SAS sub-mode. Douglas Bates (<bates@stat.wisc.edu>)
41
contributed the initial S4 mode.
42
43
We are grateful to David M. Smith, the previous developer (for S-mode
44
3.x and 4.x), as well as to the initial developers of S-mode, Doug
45
Bates, Ed Kademan and Frank Ritter.
46
47
In addition, some of the code has been and will be borrowed from Tom
48
Cook (from his excellent SAS mode) and Thomas Lumley (preliminary Stata
49
mode), gratefully (from us) and with permission (from them).
50
51
The name is ESS. Not ESS-mode.
52
53
License
54
=======
55
56
ESS is free software; you can redistribute it and/or modify it under
1
1 General Information: README
2
*****************************
3
4
This is the README file for the distribution of ESS version
5
6
5.2.6
7
8
The first release of the 5.2 series. ESS is a GNU Emacs and XEmacs
9
mode for interactive statistical programming and data analysis.
10
Languages supported: the S family (S 3/4, S-PLUS 3/4/5/6/7, and R),
11
SAS, XLispStat, Stata and BUGS. Installation help can be found in
12
sections for both Unix and Windows. ESS grew out of the desire for bug
13
fixes and extensions to S-mode and SAS-mode as well as a consistent
14
union of their features in one package.
15
16
The current development team is led by Martin Maechler since August
17
2004. Former project leader A.J. (Tony) Rossini
18
(<rossini@blindglobe.net>) did the initial port to XEmacs and has been
19
the primary coder. Martin Maechler (<maechler@stat.math.ethz.ch>) and
20
Kurt Hornik (<hornik@ci.tuwien.ac.at>) have assisted with S-PLUS, S4,
21
R, and XLispStat. Stephen Eglen (<stephen@gnu.org>) has worked mostly
22
on R support. Richard M. Heiberger (<rmh@temple.edu>) has assisted
23
with S-PLUS and S4 development for Windows. Richard and Rodney A.
24
Sparapani (<rsparapa@mcw.edu>) have done much of the work implementing
25
interactive SAS (iESS[SAS]) and batch SAS (ESS[SAS]) support.
26
27
We are grateful to the previous developers of S-mode (Doug Bates, Ed
28
Kademan, Frank Ritter, David M. Smith), SAS-mode (Tom Cook) and
29
Stata-mode (Thomas Lumley).
30
31
1.1 License
32
===========
33
34
ESS is free software; you can redistribute it and/or modify it under
57
35
the terms of the GNU General Public License as published by the Free
58
36
Software Foundation; either version 2, or (at your option) any later
59
37
version.
63
41
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
64
42
in the file COPYING in the same directory as this file for more details.
65
43
66
New Features
67
============
44
1.2 New Features
45
================
46
47
Changes/New Features in 5.2.6:
48
* Removed non-ASCII characters in a few files.
49
50
* ESS[R]: now works better when UTF-8 locale is active; in
51
particular, you get correct directional quotes in R's startup
52
message for R-devel (unstable development version of R 2.1.0)
53
when using environment variables LANGUAGE=en@quot
54
LC_ALL=en_US.UTF-8
55
56
* ESS[SAS]: toggling of .log mode improved (`F10'); toggling of .lst
57
mode now also available (`C-F10'); killing all buffers associated
58
with .sas program no longer bound to `C-F10' since its a bit
59
overzealous; EXPERIMENTAL new feature: if your .log grows to more
60
than 2.5MB, just the first 2.5MB are refreshed; this is helpful
61
when your .sas program generates lots of error messages and gets
62
too big for emacs to display; the truncation size is controlled by
63
the variable ess-sas-log-max and defaults to 2500000.
64
65
* S-Plus 7 for Windows is now recognized.
66
67
* ESS[S] (incl. R): in auto-fill mode, strings are not wrapped
68
anymore.
69
70
* ESS[S] (incl. R): font-lock now correctly differs between R and S,
71
e.g., for "_"; both now fontify warning(.) and S does terminate()
72
additionally.
73
74
* Support for `bell' aka `beep' aka `ding' aka `alarm' in all
75
inferior modes: When \a is output "to the the console" at the
76
beginning of a line, the bell is rung.
77
78
Changes/New Features in 5.2.5:
79
* ESS[R]: `C-c C-q' or `Quit S' from the menu now should work (again
80
and less klunkily) and do not append `-exited' to the buffer name.
81
Further, the behavior of `(ess-cleanup)', called from ess-quit,
82
now depends on the new customizable variable
83
`ess-S-quit-kill-buffers-p' which defaults to `nil'.
84
Consequently, the question _"Delete all buffers associated with
85
..?"_ will not be asked anymore by default.
86
87
* ESS[SAS] - ess-ebcdic-to-ascii-search-and-replace will now work
88
with the `recode' application as well which is available on many
89
platforms
90
91
* ESS[S] (incl. R): Name completion for slots of S4 objects now
92
works!
93
94
Changes/New Features in 5.2.4:
95
* The documentation now includes an overview of how to use the emacs
96
TAGS facility for S functions. (The distribution also used to
97
contain a directory `etc/other/Tags' where a ~1990 version of
98
`etags.c' was distributed; this is no longer relevant and so has
99
been deleted.)
100
101
* ESS[SAS] - When you are working with EBCDIC files on an ASCII
102
platform, .log NOTEs may display as gibberish since the EBCDIC
103
characters are not converted to ASCII prior to their display. So,
104
the function ess-ebcdic-to-ascii-search-and-replace is provided for
105
convenience and is bound to `C-F11'. This function requires the
106
`dd' command (only available on unix or unix-like platforms).
107
108
* ESS: Completion of object names is now always done dynamically
109
rather than allowing the option of using a pre-computed database
110
(by `ess-create-object-name-db') since modern computers seem fast
111
enough for dynamic completion. (We expect few users, if any, have
112
been using the pre-computed database method.)
113
114
* ESS: object completion in iESS buffers running on Windows was very
115
slow (for GNU Emacs, but not XEmacs) and has now been fixed.
116
Further, it was more or less broken for all versions of S-plus 6.x,
117
and has been fixed to work everywhere but with the Windows' GUI of
118
S-plus. The list of objects now shows unique names also when an
119
object appears more than once in the search path.
120
121
* ESS[R]: Completion of object names now also includes those
122
starting with ".".
123
124
Changes/New Features in 5.2.3:
125
* ESS: When new inferior ESS processes are created, by default they
126
will replace the current buffer (this restores behavior from pre
127
5.2.0). If you wish new ESS processes to start in another window
128
of the current frame, set inferior-ess-same-window to nil.
129
130
* New variables inferior-Splus-args and inferior-R-args provide a
131
way to pass command line arguments to starting S and R processes.
132
133
Changes/New Features in 5.2.2:
134
* bug-fixes for 5.2.1 (require 'executable), html docs, etc.
135
136
* ess-lisp-directory/../doc/info added to Info-directory-list if
137
ess-info not found by info
138
139
* ESS[R]: If you have other versions of R on your exec-path, such as
140
"R-1.8.1" with Unix or "rw1081" with Windows, ESS will find them
141
and create appropriate functions, such as M-x R-1.8.1 or M-x
142
rw1081, for calling them. By default only Unix programs beginning
143
"R-1" and "R-2" and Windows programs parallel to the version of R
144
in your exec-path will be found, but see ess-r-versions and
145
ess-rterm-versions for ways to find other versions of R.
146
147
* ESS[R]: Other versions of R, such as "R-1.8.1" on Unix and
148
"rw1081" on Windows, are added to the "ESS / Start Process /
149
Other" menu.
150
151
* ESS[S]: If you have other versions of S-Plus on your Windows
152
computer, such as S-Plus 6.1 or S-Plus 4.5, ESS will find them and
153
create appropriate functions, such as M-x splus61, for calling the
154
console version (Sqpe) inside an emacs buffer. By default only
155
programs installed in the default location will be found, but see
156
ess-SHOME-versions for ways to find other versions of S-Plus.
157
158
* ESS[S]: Other versions of Sqpe on Windows, such as "splus61", are
159
added to the "ESS / Start Process / Other" menu.
160
161
* ESS[R]: (bug fix) ess-quit (bound to C-c C-q) should now quit the
162
inferior R process, when issued from either the inferior buffer,
163
or from a .R buffer.
164
165
Changes/New Features in 5.2.1:
166
* ESS[S] (R and S-plus): now have toolbar support with icons to
167
evaluate code in the inferior process or to switch there. This
168
code is experimental and likely to change as XEmacs/Emacs issues
169
get resolved. The toolbar should be enabled if your Emacs displays
170
images, but can be disabled with the variable ess-use-toolbar.
171
Thanks to David Smith from Insightful for the S-plus logo.
172
173
* ESS[SAS]: ess-sas-graph-view (F12) enhanced; you can specify
174
external file viewers for each graphics file type via the alist
175
ess-sas-graph-view-viewer-alist; also .jpg/.gif are now handled by
176
image-mode on XEmacs, if available, otherwise by graphics
177
primitives as before
178
179
Changes/New Features in 5.2.0:
180
* ESS[BUGS]: new info documentation! now supports interactive
181
processing thanks to Aki Vehtari (mailto:Aki.Vehtari@hut.fi); new
182
architecture-independent unix support as well as support for BUGS
183
v. 0.5
184
185
* ESS[SAS]: convert .log to .sas with ess-sas-transcript; info
186
documentation improved; Local Variable bug fixes; SAS/IML
187
statements/functions now highlighted; files edited remotely by
188
ange-ftp/EFS/tramp are recognized and pressing SUBMIT opens a
189
buffer on the remote host via the local variable
190
ess-sas-shell-buffer-remote-init which defaults to "ssh"; changed
191
the definition of the variable ess-sas-edit-keys-toggle to boolean
192
rather than 0/1; added the function ess-electric-run-semicolon
193
which automatically reverse indents lines containing only "run;";
194
C-F1 creates MS RTF portrait from the current buffer; C-F2 creates
195
MS RTF landscape from the current buffer; C-F9 opens a SAS DATASET
196
with PROC INSIGHT rather than PROC FSVIEW; "inferior" aliases for
197
SAS batch: C-c C-r for submit region, C-c C-b for submit buffer,
198
C-c C-x for goto .log; C-c C-y for goto .lst
199
200
* ESS[S]: Pressing underscore ("_") once inserts " <- " (as before);
201
pressing underscore twice inserts a literal underscore. To stop
202
this smart behaviour, add "(ess-smart-underscore nil)" to your
203
.emacs after ess-site has been loaded;
204
ess-dump-filename-template-proto (new name!) now can be customized
205
successfully (for S language dialects); Support for Imenu has been
206
improved; set ess-imenu-use-S to non-nil to get an "Imenu-S" item
207
on your menubar; ess-help: Now using nice underlines (instead of
208
`nuke-* ^H_')
209
210
* ESS[R]: After (require 'essa-r), M-x ess-r-var allows to load
211
numbers from any Emacs buffer into an existing *R* process; M-x
212
ess-rdired gives a "directory editor" of R objects; fixed
213
ess-retr-lastvalue-command, i.e. .Last.value bug (thanks to David
214
Brahm)
215
216
* ESS: Support for creating new window frames has been added to ESS.
217
Inferior ESS processes can be created in dedicated frames by
218
setting inferior-ess-own-frame to t. ESS help buffers can also
219
open in new frames; see the documentation for ess-help-own-frame
220
for details. (Thanks to Kevin Rodgers for contributing code.)
221
222
Changes/New Features in 5.1.24:
223
* The version number is now correct even inside ESS/Emacs
224
225
Changes/New Features in 5.1.23:
226
* Minor more Makefile clean up.
227
228
Changes/New Features in 5.1.22:
229
* Besides info documentation, PDF and HTML documentation are also
230
provided (instead of built using "make") and available on the web
231
as well; see ESS web page (http://ess.r-project.org/) and StatLib
232
(http://lib.stat.cmu.edu/general/ESS/doc)
233
234
* Now that info documentation is available, the README.* files are
235
no longer supported. However, they are still distributed for what
236
it's worth.
237
238
* ESS is now an XEmacs package! See XEmacs Installation HOWTO
239
(http://www.xemacs.org/Install/index.html) for details
240
(specifically, items 10-15).
241
242
* ESS[SAS]: more user-friendly enhancements for remote SAS batch
243
jobs with Kermit file transfers (LOG and OUTPUT function key
244
features now supported). Multiple shells now supported so you can
245
run SAS on different computers from different buffers by setting
246
the buffer-local variable ess-sas-shell-buffer to unique buffer
247
names.
248
249
* Major re-vamping of Makefile/Makeconf.
250
251
Changes/New Features in 5.1.21:
252
* ESS[SAS]: info documentation now available!, see ESS->Help for
253
SAS; F12 opens GSASFILE nearest point for viewing either within
254
emacs, when available, or via an external viewer; more syntax
255
highlighting keywords; more enhancements for remote SAS batch jobs
256
with Kermit; new framework for remote SAS interactive jobs, see
257
ess-remote
258
259
* ESS[S]: info documentation now available!, see ESS->Help for the S
260
family
261
262
* Makefile: tag now independent of rel; info files made by
263
doc/Makefile and installed in new info sub-directory
68
264
69
265
Changes/New Features in 5.1.20:
70
266
* New `options()$STERM' in the S dialects (S, S-Plus, R). The S
88
284
* Workaround for bug in Sqpe+6 (S-PLUS 6 for Win).
89
285
90
286
* should now work even when imenu is not available (for old
91
Xemacsen).
287
XEmacsen).
92
288
93
* for SAS : XEmacs-Imenu fix; C-TAB is globalized along with your
289
* ESS[SAS]: XEmacs-Imenu fix; C-TAB is globalized along with your
94
290
function-key definitions, if specified; you can specify your SAS
95
291
library definitions outside of autoexec.sas for ess-sas-data-view
96
292
with SAS code placed in the variable ess-sas-data-view-libname,
108
304
local file variables are re-read at submit instead of only at file
109
305
open so that if you make a change it is picked up immediately;
110
306
111
* for BUGS: font-lock with `in' fixed.
307
* ESS[BUGS]: font-lock with `in' fixed.
112
308
113
309
* for STATA: font-lock bug fixed.
114
310
169
365
* Fixes for longstanding interactive SAS breakage (RMH)
170
366
171
367
Changes/New Features in 5.1.17:
172
* Documentation for Windows Installation (Rich Heiberger
173
(<rmh@surfer.stat.temple.edu>))
368
* Documentation for Windows Installation (Rich Heiberger)
174
369
175
370
* removal of ess-vars, finalization of customize support (in the
176
371
sense that there is no more use of ess-vars, but that we need to
177
fix ess-cust) (AJ Rossini (<rossini@u.washington.edu>))
372
fix ess-cust) (AJ Rossini)
178
373
179
* Many small (and large) fixes/contributions (MMaechler,
180
(<maechler@stat.math.ethz.ch>)).
374
* Many small (and large) fixes/contributions (MMaechler)
181
375
182
376
* addition of the "S-equal" variable and provide M-x ess-add-MM-keys
183
377
a way to remap "_" to `ess-S-assign', typically " <- ", but
184
customizable. (MMaechler, (<maechler@stat.math.ethz.ch>)).
378
customizable. (MMaechler)
185
379
186
380
Changes/New Features in 5.1.16:
187
381
* BUG FIXES
192
386
* BUG FIXES
193
387
194
388
Changes/New Features in 5.1.14:
195
* Yet more fixes to SAS mode, (Rich Heiberger
196
(<rmh@surfer.stat.temple.edu>) and Rodney Sparapani
197
<rsparapa@mcw.edu>)).
389
* Yet more fixes to SAS mode, (Rich Heiberger and Rodney Sparapani)
198
390
199
* Customize support (for most Emacsen which support it) (AJRossini,
200
(<rossini@biostat.washington.edu>)
391
* Customize support (for most Emacsen which support it) (AJRossini)
201
392
202
393
* ARC and ViSta support out of the box, and fixes for XLispStat
203
(AJRossini, <rossini@biostat.washington.edu>)
394
(AJRossini)
204
395
205
396
Changes/New Features in 5.1.13:
206
397
* Version numbering finally all depending on the ./VERSION file,
207
398
thanks to Martin Maechler.
208
399
209
* Yet more fixes to SAS mode, thanks to Rich Heiberger
210
(<rmh@surfer.stat.temple.edu>).
400
* Yet more fixes to SAS mode, thanks to Rich Heiberger.
211
401
212
402
Changes/New Features in 5.1.12:
213
403
* Splus 5.1 stabilized, thanks to Martin Maechler, Bill Venables,
214
404
Chuck Taylor, and others.
215
405
216
* More fixes to SAS mode, thanks to Rodney Sparapani
217
(<rsparapa@mcw.edu>) and Rich Heiberger
218
(<rmh@surfer.stat.temple.edu>).
406
* More fixes to SAS mode, thanks to Rodney Sparapani and Rich
407
Heiberger.
219
408
220
409
Changes/New Features in 5.1.11:
221
410
* More fixes to Stata mode, thanks to Brendan Halpin
222
(<brendan@essex.ac.uk>)
411
(mailto:brendan@essex.ac.uk).
223
412
224
413
* fixed bugs in ESS-elsewhere, thanks to many testers
225
414
226
415
* README.SPLUS4WIN has DETAILED instructions for S-PLUS 2000, thanks
227
to David Brahm (<brahm@alum.mit.edu>).
416
to David Brahm (mailto:brahm@alum.mit.edu).
228
417
229
* Fixes to SAS mode, thanks to Rodney Sparapani (<rsparapa@mcw.edu>)
418
* Fixes to SAS mode, thanks to Rodney Sparapani
230
419
231
420
Changes/New Features in 5.1.10:
232
421
* More fixes to Stata mode
255
444
the S language, syntax, and indentation patterns and provide the
256
445
syntactic highlighting that eases the programming tasks.
257
446
258
Current Features
259
================
447
1.3 Current Features
448
====================
260
449
261
450
* Languages Supported:
262
* S dialects (S 3/4, S-PLUS 3.x/4.x/5.x/6.x, and R)
263
264
* XLispStat including Arc and ViSta
451
* S family (S 3/4, S-PLUS 3.x/4.x/5.x/6.x/7.x, and R)
265
452
266
453
* SAS
267
454
269
456
270
457
* Stata
271
458
272
* SPSS dialects (SPSS, Fiasco (GNU project)) (under development)
459
* XLispStat including Arc and ViSta
273
460
274
* Editing source code (S, XLispStat, SAS, BUGS)
461
* Editing source code (S family, SAS, BUGS, XLispStat)
275
462
* Syntactic indentation and highlighting of source code
276
463
277
464
* Partial evaluation of code
282
469
283
470
* Batch execution (SAS, BUGS)
284
471
285
* Interacting with the process (S, XLispStat, SAS)
472
* Use of imenu to provide links to appropriate functions
473
474
* Interacting with the process (S family, SAS, XLispStat)
286
475
* Command-line editing
287
476
288
477
* Searchable Command history
289
478
290
* Command-line completion of S object names and file names
479
* Command-line completion of S family object names and file
480
names
291
481
292
482
* Quick access to object lists and search lists
293
483
295
485
296
486
* Interface to the help system
297
487
298
* Transcript manipulation (S3, S+3, S4, R, XLispStat)
488
* Transcript manipulation (S family, XLispStat)
299
489
* Recording and saving transcript files
300
490
301
491
* Manipulating and editing saved transcripts
309
499
310
500
* Previewing
311
501
312
Stability
313
=========
314
315
Versions 5.1.x are meant to be gamma-level releases. While some bugs
316
are fixed, others may have been introduced, especially with regards to
317
new features. See the file doc/TODO for details. Bug reports are
318
solicited; see the Bugs Section below. Patches or suggested coding
319
fixes with bug reports are much appreciated!
320
321
Requirements
322
============
323
324
ESS version 5.1.n (n >= 2) requires Emacs version 19.34(1) or later,
325
or version XEmacs 19.14 or later. It has been most thoroughly tested
326
with:
327
328
* S-PLUS versions 3.3, 3.4, 4.5, 5.0, 5.1, 6
329
330
* R versions >=0.49
502
1.4 Stability
503
=============
504
505
Versions 5.2.x are meant to be release-quality versions. While some
506
new features are being introduced, we are cleaning up and improving the
507
interface. We know about some remaining documentation inconsistencies.
508
Patches or suggested fixes with bug reports are much appreciated!
509
510
1.5 Requirements
511
================
512
513
ESS has been tested with
514
515
* S-PLUS 3.3-4, 4.5, 2000, 5.0-1, 6.0-2, 7.0
516
517
* R >=0.49
331
518
332
519
* S4
333
520
334
* SAS 6.x, 7.x, 8.x
521
* SAS >=6.12
335
522
336
* BUGS 0.5 or 0.6
523
* BUGS 0.5, 0.603
337
524
338
525
* Stata >=6.0
339
526
340
* XLispStat versions >=3.50
527
* XLispStat >=3.50
341
528
342
529
on the following platforms
343
530
531
* Linux (all)
532
344
533
* Solaris/SunOS (all)
345
534
346
* SGI (all)
347
348
* Linux (S-PLUS 5.0, 5.1, R, XLispStat, S4, Stata 6.0)
349
350
* Microsoft Windows 95/98/NT/2000 (SPLUS 4.5 and 2000)
351
352
* Apple Mac OS: 9 (SAS), X.1 (X11 R)
535
* Microsoft Windows 95/98/NT/2000/XP (SPLUS 4.5/2000/6.*, R, SAS and
536
BUGS)
537
538
* Apple Mac OS (SAS for OS 9 and R for OS X)
353
539
354
540
with the following versions of emacs
355
541
356
* Emacs 19.34, 20.3, 20.4, 20.5, 20.6, 20.7, 21.1
357
358
* XEmacs 19.14, 19.16, 20.0, 20.4, 21.0, 21.1.13, 21.4.x
359
360
* Emacs 19.28, 19.29 (see footnote)
542
* GNU Emacs 20.3-7, 21.1, 21.3, 21.4
543
544
* XEmacs 21.0, 21.1.13-14, 21.4.0-8, 21.4.9-13(1), 21.4.14-15,
545
21.4.17, 21.5.18
361
546
362
547
---------- Footnotes ----------
363
548
364
(1) if you have Emacs 19.29, you _may_ get it to work after
365
unpacking `19.29.tar.gz', see the installation instructions
366
367
Getting the Latest Version
368
==========================
369
370
The latest stable version of ESS is always available on the web at:
371
http://software.biostat.washington.edu/statsoft/ess/ or
372
http://lib.stat.cmu.edu/general/ESS/
373
374
Installation (from tar file)
375
============================
376
377
We now discuss installation, which might happen under Unix or
378
Microsoft Windows. First, we discuss Unix installation. *Note Unix
549
(1) require the files.el patch to revert-buffer for the Local
550
Variables updating problem
551
552
1.6 Getting the Latest Version
553
==============================
554
555
The latest released version of ESS is always available on the web at:
556
ESS web page (http://ess.r-project.org) or StatLib
557
(http://lib.stat.cmu.edu/general/ESS/)
558
559
The latest development version of ESS is available via
560
`https://svn.R-project.org/ESS/', the ESS Subversion repository. If
561
you have a Subversion client (see `http://subversion.tigris.org/'), you
562
can download the sources using:
563
% svn checkout https://svn.r-project.org/ESS/trunk PATH
564
which will put the ESS files into directory PATH. Later, within
565
that directory, `svn update' will bring that directory up to date.
566
Windows-based tools such as TortoiseSVN are also available for
567
downloading the files. Alternatively, you can browse the sources with a
568
web browser at: ESS SVN site (https://svn.r-project.org/ESS/trunk).
569
However, please use a subversion client instead to minimize the load
570
when retrieving.
571
572
If you remove other versions of ESS from your emacs load-path, you
573
can then use the development version by adding the following to .emacs:
574
575
(load "/path/to/ess-svn/lisp/ess-site.el")
576
577
Note that https is required, and that the SSL certificate for the
578
Subversion server of the R project is
579
580
Certificate information:
581
- Hostname: svn.r-project.org
582
- Valid: from Jul 16 08:10:01 2004 GMT until Jul 14 08:10:01 2014 GMT
583
- Issuer: Department of Mathematics, ETH Zurich, Zurich, Switzerland, CH
584
- Fingerprint: c9:5d:eb:f9:f2:56:d1:04:ba:44:61:f8:64:6b:d9:33:3f:93:6e:ad
585
586
(currently, there is no "trusted certificate"). You can accept this
587
certificate permanently and will not be asked about it anymore.
588
589
1.7 Installation (from tar file)
590
================================
591
592
We now discuss installation, which might happen under Unix or Microsoft
593
Windows. First, we discuss Unix installation. *Note Unix
379
594
installation::.
380
595
381
596
For Microsoft Windows Installation please skip to the *Note
382
597
Microsoft Windows installation::.
383
598
384
Unix installation
385
=================
386
387
1. cd to a directory where you keep emacs lisp files, or create a
388
new directory to hold the distribution. This directory will be
389
referred to below as "the ESS distribution directory". It will
390
contain, at the end, the tar file `ess-5.1.20.tar.gz', and a
391
directory for the ESS source, which will be termed "the
392
ESS-5.1.20 source directory".
393
394
Note that the .elc files may be installed elsewhere (as specified
395
in the Makefile) if desired.
396
397
2. Retrieve the gzipped tar file or zipped file from
398
http://software.biostat.washington.edu/statsoft/ess/essDL
399
400
3. Copy `ess-5.1.20.tar.gz' to the location where you want the
401
ESS-5.1.20 directory, and cd there. Extract the files from the
402
distribution, which will unpack into a subdirectory, ess-5.1.20.
403
gunzip ess-5.1.20.tar.gz
404
tar vxf ess-5.1.20.tar
405
(or: `gunzip < ess-5.1.20.tar.gz | tar vxf -' ). (or using GNU
406
tar: `tar zvxf ess-5.1.20.tar.gz').
407
408
The `tar' command will extract files into the current directory.
409
Do not create ess-5.1.20 yourself, or you will get an extra level
410
of depth to your directory structure.
411
412
Note if you have a very ancient version of GNU emacs (_and_ really
413
can not upgrade to Emacs 20 or higher!) you can unpack the
414
`lisp/19.29.tar.gz' file, read the ensuing `lisp/19.29/README'
415
and you may succeed...
416
417
4. Edit the file `lisp/ess-site.el' as explained in the comments
418
section of that file. Installations that are using ESS only for
419
S-Plus 6.x will probably not need to make any changes.
420
Installations that also have one or more of (S+5 S4 S+4 S+3 R
421
SAS XLispStat Stata) may need to uncomment corresponding lines
422
in `ess-site.el'.
423
424
5. READ THIS ITEM THOROUGHLY BEFORE STARTING:
425
426
In the ess-5.1.20 directory, edit the file `Makeconf' (only if you
427
want to place the executables in other locations; see LISPDIR and
428
INFODIR) and then type:
429
make
430
431
If this works, then you might try:
432
make install
433
Note that the latter does the former as well, so if you are
434
feeling lucky, you might want to skip it.
435
436
This will install the info files (and the lisp files, if they are
437
to go in another directory). Don't forget to edit the file
438
`dir' in the info directory specified by `INFODIR' in
439
`doc/Makefile'. See the sample `dir' file for an example of the
440
line to add.
441
442
If you are using XEmacs, you might do:
443
make EMACS=xemacs
444
445
and then
446
make EMACS=xemacs install
447
instead of editing the Makefile.
448
449
_Note_ that you might need to use GNU make for everything to
450
work properly
451
452
An alternative, if you are running XEmacs and have access to the
453
XEmacs system directories, would be to place the directory in the
454
site-lisp directory, and simply type `make' (and copy the
455
documentation as appropriate).
456
457
For Emacs, you would still have to move the files into the top
458
level site-lisp directory.
459
460
6. Add the line
461
(load "/PATH/ess-site")
462
to your .emacs file (or default.el or site-init.el, for a
463
site-wide installation). Replace `/PATH' above with the value of
464
ess-lisp-directory as defined in ess-site.el.
465
466
Alternatively, if ess-site.el is in your current Lisp path, you can
467
do:
468
(require 'ess-site)
469
to configure Emacs for ESS.
470
471
7. (OPTIONAL) If you are running S-PLUS or R, you might consider
472
installing the database files. From within (X)Emacs, `C-x d' to
473
the directory containing ESS. Now:
474
M-x S+6
475
(or `M-x S+5': get running. once you have reached the SPLUS
476
prompt, do:)
477
M-x ess-create-object-name-db
478
(this will create the file `ess-s+6-namedb.el'; if it isn't in
479
the ESS directory, move it there).
480
481
Then, completions will be autoloaded and will not be regenerated
482
for every session.
483
484
For R, do the same, using
485
M-x R
486
and then `M-x ess-create-object-name-db' creating
487
`ess-r-namedb.el'; if it isn't in the ESS directory, move it
488
there).
489
490
8. For more information on using ESS in your daily work, see the
491
files README.S, README.SAS, and README.XLispStat.
492
493
For the impatient, the quick version of usage follows:
494
495
9. To edit statistical programs, load the files with the requiste
496
extensions (".sas" for SAS, ".S" for S-PLUS, ".R" for R, and
497
".lsp" for XLispStat).
498
499
10. To run statistical processes under (X)Emacs:
500
501
Run S-PLUS 6.x with:
502
M-x S+6
503
(or M-x S using backwards compatibility). You will then be
504
asked for a pathname ("S starting data directory?"), from which
505
to start the process. Similarly for S-PLUS 5.x.
506
507
If you wish to run R, you can start it with:
508
M-x R
509
510
XLispStat can be run with
511
M-x XLS
512
513
An interactive SAS can be run in an `iESS[SAS]' buffer with:
514
M-x SAS
515
This works when SAS is running on a Unix machine, either the local
516
machine or over a network connection. M-x SAS does not work when
517
SAS is running on a Windows machine.
518
519
11. That's it!
520
521
Microsoft Windows installation
522
==============================
523
524
For Microsoft Windows installation, please follow the next steps:
525
(see separate instructions above for UNIX *Note Unix installation::.
526
527
1. cd to a directory where you keep emacs lisp files, or create a
528
new directory (for example, `c:\emacs\') to hold the
529
distribution. This directory will be referred to below as "the
530
ESS distribution directory". It will contain, at the end,
531
either the tar file `ess-5.1.20.tar.gz' or the zip file
532
`ess-5.1.20.zip', and a directory for the ESS source, which
533
will be termed "the ESS-5.1.20 source directory".
534
535
2. Retrieve the compressed tar file `ess-5.1.20.tar.gz' or the
536
zipped file `ess-5.1.20.zip' from one of the FTP or WWW
537
archive sites via FTP (or HTTP). Be aware that http browsers
538
on Windows frequently change the "." and "-" characters in
539
filenames to other punctuation. Please change the names back
540
to their original form.
541
542
3. Copy `ess-5.1.20.tar.gz' to the location where you want the
543
ess-5.1.20 directory, for example to
544
`c:\emacs\ess-5.1.20.tar.gz', and cd there. For example,
545
546
cd c:\emacs
547
548
Extract the files from the distribution, which will unpack
549
into a subdirectory, `ess-5.1.20'.
550
gunzip ess-5.1.20.tar.gz
551
tar vxf ess-5.1.20.tar
552
(or: `gunzip < ess-5.1.20.tar.gz | tar vxf -' ).
553
(or: from the zip file: `unzip ess-5.1.20.zip')
554
555
The `tar' command will extract files into the current directory.
556
557
Do not create `ess-5.1.20' yourself, or you will get an extra level
558
of depth to your directory structure.
559
560
4. Windows users will usually be able to use the
561
`lisp/ess-site.el' as distributed. Only rarely will changes
562
be needed.
563
564
5. Windows users will need to make sure that the directories
565
for the software they will be using is in the PATH
566
environment variable. On Windows 9x, add lines similar to
567
the following to your `c:\autoexec.bat' file:
568
path=%PATH%;c:\progra~1\spls2000\cmd
569
On Windows NT/2000, add the directories to the PATH using the
570
MyComputer menu. Note that the directory containing the
571
program is added to the PATH, not the program itself. One
572
such line is needed for each software program. Be sure to
573
use the abbreviation `progra~1' and not the long version with
574
embedded blanks. Use backslashes "\".
575
576
6. Add the line
577
(load "/PATH/ess-site")
578
to your .emacs (or _emacs) file (or default.el or
579
site-init.el, for a site-wide installation). Replace `/PATH'
580
above with the value of ess-lisp-directory as defined in
581
`ess-site.el'. Use forwardslashes `/'.
582
583
7. (OPTIONAL) If you are running Sqpe or R, you might consider
584
installing the database files. From within (X)Emacs, `C-x d'
585
to the directory containing ESS. Now:
586
M-x Sqpe+6
587
(get running. once you have reached the SPLUS prompt, do:)
588
M-x ess-create-object-name-db
589
(this will create the file `ess-s+6-namedb.el'; if it isn't
590
in the ESS directory, move it there).
591
592
Then, completions will be autoloaded and will not be regenerated
593
for every session.
594
595
For R, do the same, using
596
M-x R
597
and then `M-x ess-create-object-name-db' creating
598
`ess-r-namedb.el'; if it isn't in the ESS directory, move it
599
there).
600
601
8. For more information on using ESS in your daily work, see the
602
files doc/README.SPLUS4WIN, doc/README.S, doc/README.SAS, and
603
doc/README.XLispStat.
604
605
For the impatient, the quick version of usage follows:
606
607
9. To edit statistical programs, load the files with the
608
requisite extensions (".sas" for SAS, ".S" or "s" or "q" or
609
"Q" for S-PLUS, ".r" or ".R" for R, and ".lsp" for
610
XLispStat).
611
612
10. To run statistical processes under (X)Emacs:
613
614
Run S-PLUS 6.x or 2000 with:
615
M-x S+6
616
(or `M-x S'). You will then be asked for a pathname
617
("S starting data directory?"), from which to start the
618
process. The prompt will propose your current directory as
619
the default. Similarly for S-PLUS 6.x. Send lines or regions
620
from the emacs buffer containing your S program (for example,
621
`myfile.s') to the S-Plus Commands Window with the `C-c C-n'
622
or `C-c C-r' keys.
623
624
Run S-PLUS 6.x or 2000 inside an emacs buffer
625
M-x Sqpe+6
626
You will then be asked for a pathname ("S starting data
627
directory?"), from which to start the process. The prompt will
628
propose your current directory as the default. Similarly for
629
S-PLUS 6.x. Send lines or regions from the emacs buffer
630
containing your S program (for example, `myfile.s') to the
631
*S+6* buffer with the `C-c C-n' or `C-c C-r' keys. You do
632
not have access to interactive graphics in this mode.
633
You get Unix-like behavior, in particular the entire
634
transcript is available for emacs-style search commands.
635
636
If you wish to run R, you can start it with:
637
M-x R
599
1.8 Unix installation
600
=====================
601
602
1. cd to a directory where you want to install ESS, creating it if
603
necessary. This directory will be referred to below as ESSDIR.
604
605
2. Retrieve the latest version from ESS downloads area
606
(http://ess.r-project.org/downloads/ess) to ESSDIR.
607
608
3. Decompress/unarchive the files from the disribution.
609
gunzip ess-VERSION.tar.gz
610
tar xvf ess-VERSION.tar
611
612
(or: `gunzip < ess-VERSION.tar.gz | tar xvf -' ).
613
(or using GNU tar: `tar zxvf ess-VERSION.tar.gz').
614
615
The `tar' command will create the subdirectory ess-VERSION and
616
unarchive the files there.
617
618
4. Edit the file `ESSDIR/ess-VERSION/lisp/ess-site.el' as explained
619
in the comments section of that file.
620
621
5. Add the line
622
(load "ESSDIR/ess-VERSION/lisp/ess-site")
623
to your user or system installation file (GNU Emacs uses
624
`$HOME/.emacs' and XEmacs uses `$HOME/.xemacs/init.el' for the
625
user initialization file. GNU Emacs uses default.el or
626
site-init.el and XEmacs uses site-start.el for the system
627
installation file).
628
629
Alternatively, if ess-site.el is in your current Lisp path, you
630
can do:
631
(require 'ess-site)
632
to configure emacs for ESS.
633
634
6. That's it! If you are installing just a local copy of ESS for
635
yourself, ESS is now ready to be used. (The remaining step below
636
is for advanced installation.) To edit statistical programs, load
637
the files with the requiste extensions (".sas" for SAS, ".S" for
638
S-PLUS, ".R" for R, and ".lsp" for XLispStat). To start a
639
statistical process within Emacs, such as R, type `M-x R'.
640
641
7. (OPTIONAL) READ THIS ITEM THOROUGHLY BEFORE STARTING:
642
643
If you want to place the compiled files in other locations edit
644
the LISPDIR and INFODIR entries in `Makeconf' in the
645
ESSDIR/ess-VERSION directory (if you are using XEmacs, then you
646
also need to edit the EMACS entry as follows: EMACS=xemacs).
647
648
You can compile those files by:
649
make all
650
651
When that completes successfully, install the compiled files:
652
make install
653
654
This will install the compiled info files and lisp files. If you
655
are an XEmacs user, then you should be done. If not, then you may
656
have to edit/create the file `dir' that is found in the directory
657
specified by `INFODIR': see the sample `dir' in
658
ESSDIR/ess-VERSION/doc/info. If `dir' does not exist in
659
`INFODIR', then the sample `dir' will be installed.
660
661
_Note:_ ESS can be installed for XEmacs as an XEmacs package much
662
more easily than what has been described anywhere above. However,
663
the latest ESS version will not be available at the same time as an
664
XEmacs package; generally, it can take weeks or months to appear
665
in the latter format. For more information on installing ESS as
666
an XEmacs package see Quickstart Package Guide
667
(http://www.xemacs.org/Documentation/packageGuide.html).
668
669
670
1.9 Microsoft Windows installation
671
==================================
672
673
For Microsoft Windows installation, please follow the next steps: (see
674
separate instructions above for UNIX *Note Unix installation::.
675
676
1. cd to a directory where you keep emacs lisp files, or create a new
677
directory (for example, `c:\emacs\') to hold the distribution.
678
This directory will be referred to below as "the ESS distribution
679
directory". It will contain, at the end, either the tar file
680
`ess-VERSION.tar.gz' or the zip file `ess-VERSION.zip', and a
681
directory for the ESS source, which will be termed "the
682
ESS-VERSION source directory".
683
684
2. Retrieve the compressed tar file `ess-VERSION.tar.gz' or the
685
zipped file `ess-VERSION.zip' from one of the FTP or WWW archive
686
sites via FTP (or HTTP). Be aware that http browsers on Windows
687
frequently change the "." and "-" characters in filenames to other
688
punctuation. Please change the names back to their original form.
689
690
3. Copy `ess-VERSION.tar.gz' to the location where you want the
691
ess-VERSION directory, for example to
692
`c:\emacs\ess-VERSION.tar.gz', and cd there. For example,
693
694
cd c:\emacs
695
696
Extract the files from the distribution, which will unpack into a
697
subdirectory, `ess-VERSION'.
698
gunzip ess-VERSION.tar.gz
699
tar xvf ess-VERSION.tar
700
(or: `gunzip < ess-VERSION.tar.gz | tar xvf -' ).
701
(or: from the zip file: `unzip ess-VERSION.zip')
702
703
The `tar' command will extract files into the current directory.
704
705
Do not create `ess-VERSION' yourself, or you will get an extra
706
level of depth to your directory structure.
707
708
4. Windows users will usually be able to use the `lisp/ess-site.el'
709
as distributed. Only rarely will changes be needed.
710
711
5. Windows users will need to make sure that the directories for the
712
software they will be using is in the PATH environment variable.
713
On Windows 9x, add lines similar to the following to your
714
`c:\autoexec.bat' file:
715
path=%PATH%;c:\progra~1\spls2000\cmd
716
On Windows NT/2000/XP, add the directories to the PATH using the
717
`My Computer/Control Panel/System/Advanced/Environment Variables'
718
menu. Note that the directory containing the program is added to
719
the PATH, not the program itself. One such line is needed for
720
each software program. Be sure to use the abbreviation `progra~1'
721
and not the long version with embedded blanks. Use backslashes
722
"\".
723
724
6. Add the line
725
(load "/PATH/ess-site")
726
to your .emacs (or _emacs) file (or default.el or site-init.el, for
727
a site-wide installation). Replace `/PATH' above with the value
728
of ess-lisp-directory as defined in `ess-site.el'. Use
729
forwardslashes `/'. (GNU Emacs uses the filename `%HOME%/.emacs'
730
and XEmacs uses the filename `%HOME%/.xemacs/init.el' for the
731
initialization file.)
732
733
7. To edit statistical programs, load the files with the requisite
734
extensions (".sas" for SAS, ".S" or "s" or "q" or "Q" for S-PLUS,
735
".r" or ".R" for R, and ".lsp" for XLispStat).
736
737
8. To run statistical processes under emacs:
738
739
To start the S-PLUS [67].x GUI from ESS under emacs:
740
M-x S
741
(or `M-x S+6').
742
You will then be asked for a pathname ("S starting data
743
directory?"), from which to start the process. The prompt will
744
propose your current directory as the default. ESS will start the
745
S-PLUS GUI. There will be slight delay during which emacs is
746
temporarily frozen. ESS will arrange for communication with the
747
S-PLUS GUI using the DDE protocol. Send lines or regions from the
748
emacs buffer containing your S program (for example, `myfile.s')
749
to the S-PLUS Commands Window with the `C-c C-n' or `C-c C-r' keys.
750
(If you are still using S-PLUS 4.x or 2000, then use `M-x S+4'.)
751
752
To start an S-PLUS [67].x session inside an emacs buffer--and
753
without the S-PLUS GUI:
754
M-x Sqpe
755
(or `M-x Sqpe+6').
756
You will then be asked for a pathname ("S starting data
757
directory?"), from which to start the process. The prompt will
758
propose your current directory as the default. You get Unix-like
759
behavior, in particular the entire transcript is available for
760
emacs-style search commands. Send lines or regions from the emacs
761
buffer containing your S program (for example, `myfile.s') to the
762
*S+6* buffer with the `C-c C-n' or `C-c C-r' keys. Interactive
763
graphics are available with Sqpe by using the java library
764
supplied with S-PLUS 6.1 and newer releases. Enter the commands:
765
library(winjava)
766
java.graph()
767
Graphs can be saved from the `java.graph' device in several
768
formats, but not PostScript. If you need a PostScript file you
769
will need to open a separate `postscript' device. (If you are
770
still using S-PLUS 4.x or 2000, then use `M-x Sqpe+4'.)
771
772
To connect to an already running S-PLUS GUI (started, for example,
773
from the S-PLUS icon):
774
M-x S+6-existing
775
You will then be asked for a pathname ("S starting data
776
directory?"), from which to start the process. The prompt will
777
propose your current directory as the default. ESS will arrange
778
for communication with the already running S-PLUS GUI using the
779
DDE protocol. Send lines or regions from the emacs buffer
780
containing your S program (for example, `myfile.s') to the S-PLUS
781
Commands Window with the `C-c C-n' or `C-c C-r' keys. (If you are
782
still using S-PLUS 4.x or 2000, then use `M-x S+4-existing'.)
783
784
If you wish to run R, you can start it with:
785
M-x R
638
786
639
787
XLispStat can not currently be run with
640
M-x XLS
641
Hopefully, this will change. However, you can still edit with
642
Emacs, and cut and paste the results into the XLispStat
643
*Listener* Window under Microsoft Windows.
644
645
SAS for Windows uses the batch access with function keys that is
646
described in `doc/README.SAS'. The user can also edit SAS files
647
in an `ESS[SAS]' buffer and than manually copy and paste them
648
into an Editor window in the SAS Display Manager.
649
650
For Windows, inferior SAS in an `iESS[SAS]' buffer does not work
651
on the local machine. It does work over a network connection to
652
SAS running on a remote Unix computer.
653
654
Reason: we use ddeclient to interface with programs and SAS
655
doesn't provide the corresponding ddeserver capability.
656
657
11. That's it!
658
659
660
Reporting Bugs
661
==============
662
663
Please send bug reports, suggestions etc. to
788
M-x XLS
789
Hopefully, this will change. However, you can still edit with
790
emacs, and cut and paste the results into the XLispStat *Listener*
791
Window under Microsoft Windows.
792
793
9. That's it!
794
795
796
1.10 Reporting Bugs
797
===================
798
799
Please send bug reports, suggestions etc. to
664
800
665
801
<ESS-bugs@stat.math.ethz.ch>
666
802
671
807
This also gives the maintainers valuable information about your
672
808
installation which may help us to identify or even fix the bug.
673
809
810
If Emacs reports an error, backtraces can help us debug the problem.
811
Type "M-x set-variable RET debug-on-error RET t RET". Then run the
812
command that causes the error and you should see a *Backtrace* buffer
813
containing debug information; send us that buffer.
814
674
815
Note that comments, suggestions, words of praise and large cash
675
816
donations are also more than welcome.
676
817
677
Mailing Lists
678
=============
818
1.11 Mailing Lists
819
==================
679
820
680
There is a mailing list for discussions and announcements relating to
821
There is a mailing list for discussions and announcements relating to
681
822
ESS. Join the list by sending an e-mail with "subscribe ess-help" (or
682
823
"help") in the body to <ess-help-request@stat.math.ethz.ch>;
683
824
contributions to the list may be mailed to
696
837
697
838
* posting small patches to ESS.
698
839
699
Authors
700
=======
701
702
* A.J. Rossini (http://www.biostat.washington.edu/~rossini/)
703
<rossini@u.washington.edu>
704
705
* Richard M. Heiberger
706
(http://www.sbm.temple.edu/departments/statistics/)
707
<rmh@fisher.stat.temple.edu>
708
709
* Kurt Hornik (http://www.ci.tuwien.ac.at/~hornik)
710
<hornik@ci.tuwien.ac.at>
711
712
* Martin Maechler (http://stat.ethz.ch/~maechler/)
713
<maechler@stat.math.ethz.ch>
714
715
* Rodney Sparapani (http://www.mcw.edu/pcor/rsparapa)
716
<rsparapa@mcw.edu>
840
1.12 Authors
841
============
842
843
* A.J. Rossini (mailto:rossini@blindglobe.net)
844
845
* Richard M. Heiberger (mailto:rmh@temple.edu)
846
847
* Kurt Hornik (mailto:hornik@ci.tuwien.ac.at)
848
849
* Martin Maechler (mailto:maechler@stat.math.ethz.ch)
850
851
* Rodney A. Sparapani (mailto:rsparapa@mcw.edu)
852
853
* Stephen Eglen (mailto:stephen@gnu.org)
717
854
Loggerhead is a web-based interface for Breezy
Version: 2.0.1