ANNOUNCE

   1 ANNOUNCING ESS
   2 **************
   3
   4    The ESS Developers proudly announce the release of ESS
   5
   6    5.1.24
   7
   8    Emacs Speaks Statistics (ESS) provides an intelligent, consistent
   9 interface between the user and the software.  ESS interfaces with
  10 S-PLUS, R, SAS, BUGS and other statistical analysis packages under the
  11 Unix, Microsoft Windows, and Apple Mac OS operating systems.  ESS is a
  12 package for the GNU Emacs and XEmacs text editors whose features ESS
  13 uses to streamline the creation and use of statistical software.  ESS
  14 knows the syntax and grammar of statistical analysis packages and
  15 provides consistent display and editing features based on that
  16 knowledge.  ESS assists in interactive and batch execution of
  17 statements written in these statistical analysis languages.
  18
  19    ESS is freely available under the GNU General Public License (GPL).
  20 Please read the file COPYING which comes with the distribution, for
  21 more information about the license. For more detailed information,
  22 please read the README files that come with ESS.
  23
  24 Getting the Latest Version
  25 ==========================
  26
  27    The latest stable version of ESS is always available on the web at:
  28 ESS web page (http://software.biostat.washington.edu/ess/) or StatLib
  29 (http://lib.stat.cmu.edu/general/ESS/)
  30
  31    The latest public version of ESS can also be retrieved via cvs
  32 client.  If you have a firewall, then you may need to take appropriate
  33 action.
  34
  35    The repository name is
  36      :pserver:anoncvs@software.biostat.washington.edu:/var/anoncvs
  37
  38    Using a command-line cvs client (i.e. on Unix or DOS), first type:
  39      cvs -d :pserver:anoncvs@software.biostat.washington.edu:/var/anoncvs login
  40
  41    The password is "anoncvs".
  42
  43    Then type:
  44      cvs -d :pserver:anoncvs@software.biostat.washington.edu:/var/anoncvs co ess
  45
  46 Current Features
  47 ================
  48
  49    * Languages Supported:
  50         * S family (S 3/4, S-PLUS 3.x/4.x/5.x/6.x, and R)
  51
  52         * SAS
  53
  54         * BUGS
  55
  56         * Stata
  57
  58         * XLispStat including Arc and ViSta
  59
  60    * Editing source code (S family, SAS, BUGS, XLispStat)
  61         * Syntactic indentation and highlighting of source code
  62
  63         * Partial evaluation of code
  64
  65         * Loading and error-checking of code
  66
  67         * Source code revision maintenance
  68
  69         * Batch execution (SAS, BUGS)
  70
  71    * Interacting with the process (S family, SAS, XLispStat)
  72         * Command-line editing
  73
  74         * Searchable Command history
  75
  76         * Command-line completion of S family object names and file
  77           names
  78
  79         * Quick access to object lists and search lists
  80
  81         * Transcript recording
  82
  83         * Interface to the help system
  84
  85    * Transcript manipulation (S family, XLispStat)
  86         * Recording and saving transcript files
  87
  88         * Manipulating and editing saved transcripts
  89
  90         * Re-evaluating commands from transcript files
  91
  92    * Help File Editing (R)
  93         * Syntactic indentation and highlighting of source code.
  94
  95         * Sending Examples to running ESS process.
  96
  97         * Previewing
  98
  99 Requirements
 100 ============
 101
 102    ESS works best with either GNU Emacs version 20.3 or higher, or
 103 XEmacs version 20.0 or higher.  It has been most thoroughly tested with:
 104
 105    * S-PLUS versions 3.3, 3.4, 4.5, 5.0, 5.1, 6
 106
 107    * R versions >=0.49
 108
 109    * S4
 110
 111    * SAS 6.x, 7.x, 8.x
 112
 113    * BUGS 0.5, 0.603
 114
 115    * Stata >=6.0
 116
 117    * XLispStat versions >=3.50
 118
 119    on the following platforms
 120
 121    * Solaris/SunOS (all)
 122
 123    * SGI (all)
 124
 125    * Linux (S4, S-PLUS 5.x, R, XLispStat, Stata 6.0)
 126
 127    * Microsoft Windows 95/98/NT/2000 (SPLUS 4.5 and 2000)
 128
 129    * Apple Mac OS (SAS for OS 9 and X11 R for OS X)
 130
 131    with the following versions of emacs
 132
 133    * GNU Emacs 20.3, 20.4, 20.5, 20.6, 20.7, 21.1
 134
 135    * XEmacs 20.0, 20.4, 21.0, 21.1.13, 21.1.14, 21.4
 136
 137    * XEmacs 19.14, 19.16 and GNU Emacs 19.28, 19.29, 19.34(1)
 138
 139    ---------- Footnotes ----------
 140
 141    (1) Note  that you must have `custom' support.  It is available at
 142 The Custom Library (http://www.dina.kvl.dk/~abraham/custom/).   These
 143 releases of emacs are no longer supported, so an upgrade is
 144 recommended if you plan to use ESS.  If you have GNU Emacs 19.29,  see
 145 *Note Unix installation::.
 146
 147 Stability
 148 =========
 149
 150    Versions 5.1.x are meant to be gamma-level releases.  While some bugs
 151 are fixed, others may have been introduced, especially with regards to
 152 new features.  See the file doc/TODO for details.  Bug reports are
 153 solicited; see the Bugs Section below.  Patches or suggested coding
 154 fixes with bug reports are much appreciated!
 155
 156 Mailing List
 157 ============
 158
 159    There is a mailing list for discussions and announcements relating to
 160 ESS.  Join the list by sending an e-mail with "subscribe ess-help" (or
 161 "help") in the body to <ess-help-request@stat.math.ethz.ch>;
 162 contributions to the list may be mailed to
 163 <ess-help@stat.math.ethz.ch>.  Rest assured, this is a fairly
 164 low-volume mailing list.
 165
 166    The purposes of the mailing list include
 167
 168    *  helping users of ESS to get along with it.
 169
 170    *  discussing aspects of using ESS on Emacs and XEmacs.
 171
 172    *  suggestions for improvements.
 173
 174    *  announcements of new releases of ESS.
 175
 176    *  posting small patches to ESS.
 177
 178 Reporting Bugs
 179 ==============
 180
 181    Please send bug reports, suggestions etc. to
 182
 183    <ESS-bugs@stat.math.ethz.ch>
 184
 185    The easiest way to do this is within Emacs by typing
 186
 187    `M-x ess-submit-bug-report'
 188
 189    This also gives the maintainers valuable information about your
 190 installation which may help us to identify or even fix the bug.
 191
 192    Note that comments, suggestions, words of praise and large cash
 193 donations are also more than welcome.
 194
 195 Authors
 196 =======
 197
 198    * A.J. Rossini (mailto:rossini@u.washington.edu)
 199
 200    * Richard M. Heiberger (mailto:rmh@surfer.sbm.temple.edu)
 201
 202    * Kurt Hornik (mailto:hornik@ci.tuwien.ac.at)
 203
 204    * Martin Maechler (mailto:maechler@stat.math.ethz.ch)
 205
 206    * Rodney A. Sparapani (mailto:rsparapa@mcw.edu)
 207
 208 License
 209 =======
 210
 211    ESS is free software; you can redistribute it and/or modify it under
 212 the terms of the GNU General Public License as published by the Free
 213 Software Foundation; either version 2, or (at your option) any later
 214 version.
 215
 216    ESS is distributed in the hope that it will be useful, but WITHOUT
 217 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 218 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 219 in the file COPYING in the same directory as this file for more details.
 220
 221 New Features
 222 ============
 223
 224    Changes/New Features in 5.1.23:
 225    * The version number is now correct even inside ESS/Emacs
 226
 227    * Minor more Makefile clean up.
 228
 229    Changes/New Features in 5.1.22:
 230    * Besides info documentation, PDF and HTML documentation are also
 231      provided (instead of built using "make") and available on the web
 232      as well; see ESS web page
 233      (http://software.biostat.washington.edu/ess/doc) and StatLib
 234      (http://lib.stat.cmu.edu/general/ESS/doc)
 235
 236    * Now that info documentation is available, the README.* files are
 237      no longer supported.  However, they are still distributed for what
 238      it's worth.
 239
 240    * ESS is now an XEmacs package!  See XEmacs Installation HOWTO
 241      (http://www.xemacs.org/Install/index.html) for details
 242      (specifically, items 10-15).
 243
 244    * ESS[SAS]: more user-friendly enhancements for remote SAS batch
 245      jobs with Kermit file transfers (LOG and OUTPUT function key
 246      features now supported).  Multiple shells now supported so you can
 247      run SAS on different computers from different buffers by setting
 248      the buffer-local variable ess-sas-shell-buffer to unique buffer
 249      names.
 250
 251    * Major re-vamping of Makefile/Makeconf.
 252
 253    Changes/New Features in 5.1.21:
 254    * ESS[SAS]: info documentation now available!, see ESS->Help for
 255      SAS; F12 opens GSASFILE nearest point for viewing either within
 256      emacs, when available, or via an external viewer; more syntax
 257      highlighting keywords; more enhancements for remote SAS batch jobs
 258      with Kermit; new framework for remote SAS interactive jobs, see
 259      ess-remote
 260
 261    * ESS[S]: info documentation now available!, see ESS->Help for the S
 262      family
 263
 264    * Makefile: tag now independent of rel; info files made by
 265      doc/Makefile and installed in new info sub-directory
 266
 267    Changes/New Features in 5.1.20:
 268    * New `options()$STERM' in the S dialects (S, S-Plus, R).  The S
 269      program can determine the environment in which it is currently
 270      running.  ESS sets the option to `iESS' or `ddeESS' when it starts
 271      an S language process.  We recommend other specific values for S
 272      language processes that ESS does not start.
 273
 274    * New `ess-mouse-me' function, assigned to S-mouse-3 by default.
 275      User may click on a word or region and then choose from the menu
 276      to display the item, or a summary, or a plot, etc.  This feature
 277      is still under development.
 278
 279    * GNU Emacs 21.1 is now supported (fixed for S dialects, SAS & BUGS),
 280      (some from Stephen Eglen).
 281
 282    * XEmacs 21.x is now supported (fixed w32-using-nt bug)
 283
 284    * XEmacs on Win (NT) is better supported.
 285
 286    * Workaround for bug in Sqpe+6 (S-PLUS 6 for Win).
 287
 288    * should now work even when imenu is not available (for old
 289      Xemacsen).
 290
 291    * ESS[SAS]: XEmacs-Imenu fix; C-TAB is globalized along with your
 292      function-key definitions, if specified; you can specify your SAS
 293      library definitions outside of autoexec.sas for ess-sas-data-view
 294      with SAS code placed in the variable ess-sas-data-view-libname,
 295      also the dataset name is defaulted to the nearest permanent dataset
 296      to point; Speedbar support now works for permanent datasets, please
 297      ignore first./last.; new font-locking is now the default with more
 298      improvements for font-locking PROCs, macro statements, * ; and %* ;
 299      comments; you can toggle sas-log-mode with F10 which will font-lock
 300      your .log (if it isn't too big); submit remote .sas files accessed
 301      with ange-ftp, EFS or Tramp (Kermit is experimental) by setting
 302      ess-sas-submit-method to 'sh; ess-sas-submit-command and
 303      ess-sas-submit-command-options are buffer-local so you can have
 304      local file variable sections at the end of your .sas files to
 305      request different executables or specify special options and the
 306      local file variables are re-read at submit instead of only at file
 307      open so that if you make a change it is picked up immediately;
 308
 309    * ESS[BUGS]: font-lock with `in' fixed.
 310
 311    * for STATA: font-lock bug fixed.
 312
 313    * for Rd mode: C-c C-v and `switch-process' in menu.  further, C-c
 314      C-f prefix (Rd-font) for inserting or surrounding a word by things
 315      such as \code{.}, \code{\link{.}}, \emph{.} etc.
 316
 317    * new functions (ess-directory-function) and (ess-narrow-to-defun)
 318      ess-directory <-> default-directory logic (Jeff Mincy).
 319
 320    * Re-organized Makefile and fixed a few bugs.
 321
 322    Changes/New Features in 5.1.19:
 323    * S+6 now supported (Tony Rossini (Unix) and Rich Heiberger
 324      (Windows))
 325
 326    * New BUGS support through ESS[BUGS] mode (Rodney Sparapani)
 327      Templates assist you in writing .bug and .cmd code (.cmd and .log
 328      are replaced by .bmd and .bog to avoid emacs extension collisions).
 329      Substitution" parameters facilitate "automagic" generation of
 330      data...in" and "init...in" filenames, "const N=" from your data
 331      file and "monitor()/stats()" commands.  Activated by pressing F12.
 332
 333    * Fixes for `ess-smart-underscore' SAS breakage (Rich Heiberger)
 334
 335    * You can change between PC and Unix, local and global SAS
 336      function-key definitions interactively (Rich Heiberger)
 337
 338    * C-Submit a highlighted region to SAS batch (Rodney Sparapani)
 339
 340    * New and improved SAS syntax highlighting (Rodney Sparapani) To get
 341      the new functionality, set ess-sas-run-make-regexp to nil.  Also
 342      available in .log files via F10.
 343
 344    * Open a permanent SAS dataset for viewing via F9 (Rodney Sparapani)
 345      You must have the library defined in autoexec.sas for it to work.
 346
 347    * User-friendly defaults for `sas-program',
 348      `ess-sas-batch-pre-command' and `ess-sas-batch-post-command' as
 349      well Customize support for these and other ESS[SAS] variables
 350      (Rodney Sparapani)
 351
 352    * `ess-sas-suffix-2' now defaults to .dat via F11 (Rodney Sparapani)
 353
 354    * Emacs/XEmacs, Unix/Windows issues collectively handled in
 355      ess-emcs.el
 356
 357    * defadvice solves problem of missing *ESS* (thanks to Jeff Mincy)
 358
 359    * Improved manual a bit by including things that were only in
 360      `README'.
 361
 362    Changes/New Features in 5.1.18:
 363    * New `ess-smart-underscore' function, now assigned to "_" by
 364      default.  Inserts `ess-S-assign' (customizable " <- "), unless
 365      inside string and comments where plain "_" is used instead. (MM)
 366
 367    * Fixes for longstanding interactive SAS breakage (RMH)
 368
 369    Changes/New Features in 5.1.17:
 370    * Documentation for Windows Installation (Rich Heiberger)
 371
 372    * removal of ess-vars, finalization of customize support (in the
 373      sense that there is no more use of ess-vars, but that we need to
 374      fix ess-cust) (AJ Rossini)
 375
 376    * Many small (and large) fixes/contributions (MMaechler)
 377
 378    * addition of the "S-equal" variable and provide M-x ess-add-MM-keys
 379      a way to remap "_" to `ess-S-assign', typically " <- ", but
 380      customizable. (MMaechler)
 381
 382    Changes/New Features in 5.1.16:
 383    * BUG FIXES
 384
 385    * Better SAS support
 386
 387    Changes/New Features in 5.1.15:
 388    * BUG FIXES
 389
 390    Changes/New Features in 5.1.14:
 391    * Yet more fixes to SAS mode, (Rich Heiberger and Rodney Sparapani)
 392
 393    * Customize support (for most Emacsen which support it) (AJRossini)
 394
 395    * ARC and ViSta support out of the box, and fixes for XLispStat
 396      (AJRossini)
 397
 398    Changes/New Features in 5.1.13:
 399    * Version numbering finally all depending on the ./VERSION file,
 400      thanks to Martin Maechler.
 401
 402    * Yet more fixes to SAS mode, thanks to Rich Heiberger.
 403
 404    Changes/New Features in 5.1.12:
 405    * Splus 5.1 stabilized, thanks to Martin Maechler, Bill Venables,
 406      Chuck Taylor, and others.
 407
 408    * More fixes to SAS mode, thanks to Rodney Sparapani and Rich
 409      Heiberger.
 410
 411    Changes/New Features in 5.1.11:
 412    * More fixes to Stata mode, thanks to Brendan Halpin
 413      (mailto:brendan@essex.ac.uk).
 414
 415    * fixed bugs in ESS-elsewhere, thanks to many testers
 416
 417    * README.SPLUS4WIN has DETAILED instructions for S-PLUS 2000, thanks
 418      to David Brahm (mailto:brahm@alum.mit.edu).
 419
 420    * Fixes to SAS mode, thanks to Rodney Sparapani
 421
 422    Changes/New Features in 5.1.10:
 423    * More fixes to Stata mode
 424
 425    * primitive generic version of ESS-elsewhere
 426
 427    * Small fixes to SAS/Stata.
 428
 429    Changes/New Features in 5.1.9:
 430    * Stata mode works
 431
 432    * Literate Data Analysis using Noweb works
 433
 434    Changes/New Features in 5.1.8:
 435    * Bug fixes
 436
 437    * R documentation mode defaults changed
 438
 439    Changes/New Features in 5.1.2:
 440    * able to use inferior iESS mode to communicate directly with a
 441      running S-Plus 4.x process using the Microsoft DDE protocol.  We
 442      use the familiar (from Unix ESS) C-c C-n and related key sequences
 443      to send lines from the S-mode file to the inferior S process.  We
 444      continue to edit S input files in ESS[S] mode and transcripts of
 445      previous S sessions in ESS Transcript mode.  All three modes know
 446      the S language, syntax, and indentation patterns and provide the
 447      syntactic highlighting that eases the programming tasks.
 448