| blob | fe579634d4d1a34b432ca5a298d59e6c612232f0 |
2 <head>
21 </head>
22 <body>
26 <!-- node-name, next, previous, up -->
28 <p><hr>
34 </div>
38 <p>ESS version
39 5.2.12
42 R.M. Heiberger,
43 K. Hornik,
44 M. Maechler,
45 R.A. Sparapani
46 and S.J. Eglen.
47 </pre>
48 <!-- (Formerly: Doug -->
49 <!-- Bates, Ed Kademan, Frank Ritter and David Smith). -->
50 <blockquote>
51 Emacs Speaks Statistics (ESS) provides an intelligent, consistent
52 interface between the user and the software. ESS interfaces with
53 SAS, S-PLUS, R, BUGS and other statistical analysis packages under
54 the Unix, Microsoft Windows, and Apple Mac operating systems. ESS
55 is itself a package within the emacs text editor and uses emacs
56 features to streamline the creation and use of statistical software.
57 ESS knows the syntax and grammar of statistical analysis packages
58 and provides consistent display and editing features based on that
59 knowledge. ESS assists in interactive and batch execution of
60 statements written in these statistical analysis languages.
61 </blockquote>
64 <li><a accesskey="1" href="#Introduction">Introduction</a>: Overview of features provided by this package
67 <li><a accesskey="3" href="#Interactive-ESS">Interactive ESS</a>: Interacting with statistical programs
68 <li><a accesskey="4" href="#Entering-commands">Entering commands</a>: Interacting with the ESS process
69 <li><a accesskey="5" href="#Transcript-Mode">Transcript Mode</a>: Manipulating saved transcript files
80 <li><a href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>: How to get assistance with ESS
86 <!-- @detailmenu -->
87 <!-- The Detailed Node Listing - -->
88 <!-- Introduction to ESS -->
89 <!-- * Features:: Why should I use ESS? -->
90 <!-- * New features:: -->
91 <!-- * Credits:: Authors of and contributors to ESS -->
92 <!-- * Latest version:: Getting the latest version of ESS -->
93 <!-- * Manual:: How to read this manual -->
94 <!-- Installing ESS on your system -->
95 <!-- * Unix installation:: Installing ESS on your Unix system -->
96 <!-- * Microsoft Windows installation:: Installing ESS on your MS Windows system -->
97 <!-- * Requirements:: emacs, Operating Systems and Statistical Packages -->
98 <!-- * System dependent:: Other variables you may need to change -->
99 <!-- Starting the ESS process -->
100 <!-- * Multiple ESS processes:: -->
101 <!-- * ESS processes on Remote Computers:: -->
102 <!-- * Customizing startup:: Changing the startup actions -->
103 <!-- Help for the S family -->
104 <!-- * ESS(S)-Editing files:: -->
105 <!-- * iESS(S)-Inferior ESS processes:: -->
106 <!-- * Handling and Reusing Transcripts:: -->
107 <!-- * ESS-help-assistance with viewing help:: -->
108 <!-- * Philosophies for using ESS(S):: -->
109 <!-- * Scenarios for use (possibilities-based on actual usage):: -->
110 <!-- * Customization Examples and Solutions to Problems:: -->
111 <!-- Help for SAS -->
112 <!-- * ESS(SAS)-Design philosophy:: -->
113 <!-- * ESS(SAS)-Editing files:: -->
114 <!-- * iESS(SAS)-Interactive SAS processes:: -->
115 <!-- * ESS(SAS)-Batch SAS processes:: -->
116 <!-- * ESS(SAS)-Function keys for batch processing:: -->
117 <!-- * ESS(SAS)-TAB key:: -->
118 <!-- * ESS(SAS)-Usage scenarios:: -->
119 <!-- * iESS(SAS)-Common problems:: -->
120 <!-- * ESS(SAS)-MS Windows:: -->
121 <!-- Interacting with the ESS process -->
122 <!-- * Command-line editing:: Entering commands and fixing mistakes -->
123 <!-- * Completion:: Completion of object names -->
124 <!-- * Completion details:: Advanced completion concepts -->
125 <!-- * Transcript:: Manipulating the transcript -->
126 <!-- * Command History:: Command History -->
127 <!-- * History expansion:: References to historical commands -->
128 <!-- * Hot keys:: Hot keys for common commands -->
129 <!-- * Statistical Process running in ESS?:: -->
130 <!-- * Other:: Other commands provided by inferior-ESS -->
131 <!-- Manipulating the transcript -->
132 <!-- * Last command:: Manipulating the output from the last command -->
133 <!-- * Process buffer motion:: Viewing older commands -->
134 <!-- * Transcript resubmit:: Re-submitting commands from the transcript -->
135 <!-- * Saving transcripts:: Keeping a record of your S session -->
136 <!-- Editing S functions -->
137 <!-- * Edit buffer:: Edit objects in a specialized buffer -->
138 <!-- * Loading:: Loading source files into the ESS process -->
139 <!-- * Error Checking:: Detecting errors in source files -->
140 <!-- * Evaluating code:: Sending code to the ESS process -->
141 <!-- * Indenting:: Indenting and formatting @Sl{} code -->
142 <!-- * Other edit buffer commands:: Commands for motion, completion and more -->
143 <!-- * Source Files:: Maintaining @Sl{} source files -->
144 <!-- * Source Directories:: Names and locations of dump files -->
145 <!-- Manipulating saved transcript files -->
146 <!-- * Resubmit:: Resubmitting commands from the transcript file -->
147 <!-- * Clean:: Cleaning transcript files -->
148 <!-- Other features of ESS -->
149 <!-- * Highlighting:: Syntactic highlighting of buffers -->
150 <!-- * Graphics:: Using graphics with ESS -->
151 <!-- * Object Completion:: -->
152 <!-- Using graphics with ESS -->
153 <!-- * printer:: The printer() graphics driver -->
154 <!-- * X11:: The X11() (and other X-windows based) driver -->
155 <!-- Bugs and Bug Reporting, Mailing Lists -->
156 <!-- * Bugs:: -->
157 <!-- * Reporting Bugs:: -->
158 <!-- * Mailing Lists:: -->
159 <!-- Customizing ESS -->
160 <!-- * Variables:: Variables for customization -->
161 <!-- * Hooks:: Customizing ESS with hooks -->
162 <!-- * Keybindings:: Changing the default ESS keybindings -->
163 <!-- Variables for customization -->
164 <!-- * Variables for starting ESS:: Variables for starting ESS -->
165 <!-- * Dump file variables:: Variables for dump files -->
166 <!-- * Indentation variables:: Variables controlling indentation -->
167 <!-- * Variables controlling interaction:: Variables controlling interaction -->
168 <!-- with the ESS process -->
169 <!-- @end detailmenu -->
170 </ul>
172 <!-- node-name, next, previous, up -->
174 <p><hr>
180 </div>
185 The S family (S, Splus and R) and SAS statistical analysis packages
186 provide sophisticated statistical and graphical routines for manipulating
188 of two pre-cursors, S-mode and SAS-mode, which provided support for the
189 S family and SAS respectively. Later on, Stata-mode was also incorporated.
191 <p>ESS provides a common, generic, and useful interface, through emacs, to
192 many statistical packages. It currently supports the S family, SAS, BUGS,
193 Stata and XLisp-Stat with the level of support roughly in that order.
200 (the connection between emacs and the running process) referred to as inferior ESS
202 <code>dialect</code> can take values such as <code>S3</code>, <code>S4</code>, <code>S+3</code>,
203 <code>S+4</code>, <code>S+5</code>, <code>S+6</code>, <code>S+7</code>, <code>R</code>, <code>XLS</code>, <code>VST</code>, <code>SAS</code>.
206 where actually any supported (statistics) language is meant, i.e., `S'
207 could also mean `XLisp-Stat' or `SAS'.
210 <a name="index-using-S-interactively-3"></a>For exclusively interactive users of S, ESS provides a number of
211 features to make life easier. There is an easy to use command history
212 mechanism, including a quick prefix-search history. To reduce typing,
213 command-line completion is provided for all S objects and “hot
214 keys” are provided for common S function calls. Help files are
215 easily accessible, and a paging mechanism is provided to view them.
216 Finally, an incidental (but very useful) side-effect of ESS is that a
217 transcript of your session is kept for later saving or editing.
219 <p><a name="index-transcripts-of-S-sessions-4"></a>No special knowledge of Emacs is necessary when using S
220 interactively under ESS.
222 <p><a name="index-programming-in-S-5"></a>For those that use S in the typical edit–test–revise cycle when
223 programming S functions, ESS provides for editing of S functions
224 in Emacs edit buffers. Unlike the typical use of S where the editor
225 is restarted every time an object is edited, ESS uses the current Emacs
226 session for editing. In practical terms, this means that you can edit
227 more than one function at once, and that the ESS process is still
228 available for use while editing. Error checking is performed on
229 functions loaded back into S, and a mechanism to jump directly to the
230 error is provided. ESS also provides for maintaining text versions of
231 your S functions in specified source directories.
237 <li><a accesskey="4" href="#Latest-version">Latest version</a>: Getting the latest version of ESS
239 </ul>
241 <!-- node-name, next, previous, up -->
243 <p><hr>
249 </div>
253 <p>Statistical packages are powerful software systems for manipulating and
254 analyzing data, but their user interfaces often leave something something
255 to be desired: they offer weak editor functionality and they differ
256 among themselves so markedly that you have to re-learn how to do those
257 things for each package. ESS is a package which is designed to make
258 editing and interacting with statistical packages more uniform,
259 user-friendly and give you the power of emacs as well.
261 <p>ESS provides several features which make it easier to interact with the
262 ESS process (a connection between your buffer and the statistical
263 package which is waiting for you to input commands). These include:
265 <ul>
267 entered. The `<samp><span class="samp">-e</span></samp>' flag for S-plus provides something similar to
268 this, but here you have the full range of Emacs commands rather than a
269 limited subset. However, other packages such as XLisp-Stat and S3 do not
270 necessarily have features like this built-in.
274 commands. This provides all the features of the `<samp><span class="samp">Splus -e</span></samp>' history
275 mechanism, plus added features such as history searching.
280 also applies to object names and list components.
288 S session.
292 help files.
295 </ul>
297 <p>If you commonly create or modify S functions, you will have found
298 the standard facilities for this (the `<samp><span class="samp">fix()</span></samp>' function, for
299 example) severely limiting. Using S's standard features, one can only
300 edit one function at a time, and you can't continue to use S while
301 editing. ESS corrects these problems by introducing the following
302 features:
304 <ul>
306 simultaneously in dedicated Emacs buffers. The ESS process may
307 continue to be used while functions are being edited.
311 indentation and highlighting.
315 keystroke to jump straight to the position of an error in a source file.
319 versions of S source files.
323 files, or line-by-line evaluation of files (useful for debugging).
325 </ul>
327 <p>Finally, ESS provides features for re-submitting commands from saved
328 transcript files, including:
330 <ul>
332 unnecessary prompts.
335 </ul>
337 <!-- node-name, next, previous, up -->
339 <p><hr>
345 </div>
350 <ul>
351 <li><acronym>ESS[SAS]</acronym>: <kbd>M-;</kbd> fixed, but the XEmacs function <code>comment-dwim</code>
353 instead; only valid PROCs are fontified which is very helpful finding syntax errors
354 (currently supported: BASE, ETS, FSP, GRAPH, IML, INSIGHT and STAT).
355 <li>Rterm/Cygwin combination works under Microsoft Windows.
357 define 'baseenv' where needed.
358 </ul>
361 <ul>
362 <li>ESS Info entry and <samp><span class="file">dir</span></samp> handled more effectively for GNU Emacs users
366 <li>iESS[SAS]: fixed a few nagging bugs, however, still does not appear to
367 work at this time; please let us know if you have any ideas.
371 Splus you would like to run.
372 </ul>
375 <ul>
377 customization was not taking effect unless customizations were loaded
378 before ESS). Its value has been changed so that it will also find R
380 change this variable, it must be set in your <samp><span class="file">.emacs</span></samp> before ESS is
381 loaded.
382 <li>Installation with GNU Make enhanced: unix and unix-like
384 users in either a GNU Emacs site-lisp or an XEmacs package
385 configuration by editing <samp><span class="file">lisp/ess-site.el</span></samp> and <samp><span class="file">Makeconf</span></samp>
388 XEmacs for R and S-plus.
389 <!-- working around a bug in Xemacs -->
390 </ul>
393 <ul>
395 with respect to ess-load-file has been eradicated.
396 <li>i<acronym>ESS[SAS]</acronym><!-- /@w -->: <kbd>C-c C-r</kbd> and <kbd>C-c C-b</kbd> once again
397 work as intended and documented.
402 cases, including S4 method definitions.
406 were being treated as bogus.
409 buffer is not bogus, but instead is now relabelled “*help[R](rlm in
410 packages)*”.
411 <li><acronym>ESS[STA]</acronym>: add “//” as comment starting character to syntax-table.
412 </ul>
415 <ul>
418 </ul>
421 <ul>
422 <li>If you use Custom to change the variable ess-toolbar-items,
423 the new toolbar is used in all subsequent ESS buffers.
425 your .log grows to more than ess-sas-log-max bytes, just
426 the first ess-sas-log-max bytes are refreshed; this is helpful when your .sas program
427 generates lots of error messages and gets too big for emacs to display
429 either one or two hashes depending on context.
431 are now available (from ess-swv.el loaded by default).
432 </ul>
435 <ul>
436 <li>Removed non-ASCII characters in a few files.
438 particular, you get correct directional quotes in R's startup message
439 for R-devel (unstable development version of R 2.1.0) when using
440 environment variables LANGUAGE=en@quot LC_ALL=en_US.UTF-8
447 e.g., for "_"; both now fontify warning(.) and S does terminate() additionally.
448 <li>Support for `bell' aka `beep' aka `ding' aka `alarm' in all inferior
450 the bell is rung.
451 </ul>
454 <ul>
455 <li><acronym>ESS[R]</acronym>: <kbd>C-c C-q</kbd> or `<samp><span class="samp">Quit S</span></samp>' from the menu now should work
456 (again and less klunkily) and do not append `<samp><span class="samp">-exited</span></samp>' to the
458 ess-quit, now depends on the new customizable variable
465 </ul>
468 <ul>
469 <li>The documentation now includes an overview of how to use the emacs
470 TAGS facility for S functions. (The distribution also used to contain a
471 directory <samp><span class="file">etc/other/Tags</span></samp> where a ~1990 version of <samp><span class="file">etags.c</span></samp> was
472 distributed; this is no longer relevant and so has been deleted.)
474 platform, .log NOTEs may display as gibberish since the EBCDIC
475 characters are not converted to ASCII prior to their display. So,
476 the function ess-ebcdic-to-ascii-search-and-replace is provided for
479 <li>ESS: Completion of object names is now always done dynamically rather
480 than allowing the option of using a pre-computed database (by
482 enough for dynamic completion. (We expect few users, if any, have
483 been using the pre-computed database method.)
484 <li>ESS: object completion in iESS buffers running on Windows was
485 very slow (for GNU Emacs, but not XEmacs) and has now been fixed.
486 Further, it was more or less broken for all versions of S-plus 6.x,
487 and has been fixed to work everywhere but with the Windows' GUI of
488 S-plus. The list of objects now shows unique names also when an
489 object appears more than once in the search path.
492 </ul>
495 <ul>
496 <li>ESS: When new inferior ESS processes are created, by default they
497 will replace the current buffer (this restores behavior from pre
498 5.2.0). If you wish new ESS processes to start in another window of the
499 current frame, set inferior-ess-same-window to nil.
500 <li>New variables inferior-Splus-args and inferior-R-args provide a
501 way to pass command line arguments to starting S and R processes.
502 </ul>
505 <ul>
507 <li>ess-lisp-directory/../doc/info added to Info-directory-list
508 if ess-info not found by info
511 ESS will find them and create appropriate functions, such as
513 By default only Unix programs beginning "R-1" and
514 "R-2" and Windows programs parallel to the
515 version of R in your exec-path will be found,
516 but see ess-r-versions and ess-rterm-versions for ways to find other
517 versions of R.
519 Windows, are added to the
520 "ESS / Start Process / Other" menu.
524 inside an emacs buffer. By default only
525 programs installed in the default location will be found, but see
526 ess-SHOME-versions for ways to find other versions of S-Plus.
528 are added to the
529 "ESS / Start Process / Other" menu.
530 <li><acronym>ESS[R]</acronym>: (bug fix) ess-quit (bound to <kbd>C-c C-q</kbd>) should now quit the
531 inferior R process, when issued from either the inferior buffer, or from
532 a .R buffer.
533 </ul>
536 <ul>
538 with icons to evaluate code in the inferior process or to switch
539 there. This code is experimental and likely to change as XEmacs/Emacs
540 issues get resolved. The toolbar should be enabled if your Emacs
541 displays images, but can be disabled with the variable ess-use-toolbar.
542 Thanks to David Smith from Insightful for the S-plus logo.
544 external file viewers for each graphics file type via the alist
545 ess-sas-graph-view-viewer-alist; also .jpg/.gif are now handled
546 by image-mode on XEmacs, if available, otherwise by graphics
547 primitives as before
548 </ul>
551 <ul>
554 new architecture-independent unix support as well as support for BUGS v. 0.5
556 info documentation improved; Local Variable bug fixes;
557 SAS/IML statements/functions now highlighted; files edited
558 remotely by ange-ftp/EFS/tramp are recognized and pressing
559 SUBMIT opens a buffer on the remote host via the local variable
560 ess-sas-shell-buffer-remote-init which defaults to "ssh";
561 changed the definition of the variable ess-sas-edit-keys-toggle
563 which automatically reverse indents lines containing only "run;";
568 <kbd>C-c C-b</kbd> for submit buffer, <kbd>C-c C-x</kbd> for goto .log; <kbd>C-c C-y</kbd> for goto .lst
570 pressing underscore twice inserts a literal underscore. To stop this
571 smart behaviour, add "(ess-toggle-underscore nil)" to your .emacs after
572 ess-site has been loaded;
573 ess-dump-filename-template-proto (new name!) now can be
574 customized successfully (for S language dialects);
575 Support for Imenu has been improved; set ess-imenu-use-S to non-nil to
576 get an "Imenu-S" item on your menubar;
577 ess-help: Now using nice underlines (instead of `nuke-* ^H_')
579 numbers from any Emacs buffer into an existing *R* process;
581 fixed ess-retr-lastvalue-command, i.e. .Last.value bug
582 (thanks to David Brahm)
583 <li>ESS: Support for creating new window frames has been added to
584 ESS. Inferior ESS processes can be created in dedicated frames by
585 setting inferior-ess-own-frame to t. ESS help buffers can also open in
586 new frames; see the documentation for ess-help-own-frame for details.
587 (Thanks to Kevin Rodgers for contributing code.)
588 </ul>
591 <ul>
592 <li>The version number is now correct even inside ESS/Emacs
593 </ul>
596 <ul>
597 <li>Minor more Makefile clean up.
598 </ul>
601 <ul>
602 <li>Besides info documentation, PDF and HTML
603 documentation are also provided (instead of built using "make") and available
604 on the web as well; see <a href="http://ess.r-project.org/">ESS web page</a> and <a href="http://lib.stat.cmu.edu/general/ESS/doc">StatLib</a>
605 <li>Now that info documentation is available, the
606 README.* files are no longer supported. However, they
607 are still distributed for what it's worth.
608 <li>ESS is now an XEmacs package! See
612 SAS batch jobs with Kermit file transfers (LOG and OUTPUT
613 function key features now supported). Multiple shells
614 now supported so you can run SAS on different computers
615 from different buffers by setting the buffer-local variable
616 ess-sas-shell-buffer to unique buffer names.
617 <li>Major re-vamping of Makefile/Makeconf.
618 </ul>
621 <ul>
624 either within emacs, when available, or via an external viewer;
625 more syntax highlighting keywords; more enhancements for remote
626 SAS batch jobs with Kermit; new framework for remote SAS interactive
627 jobs, see ess-remote
629 ESS->Help for the S family
630 <li>Makefile: tag now independent of rel; info files
631 made by doc/Makefile and installed in new info sub-directory
632 </ul>
635 <ul>
636 <li>New `options()$STERM' in the S dialects (S, S-Plus, R).
637 The S program can determine the environment in which it is
638 currently running. ESS sets the option to `iESS' or `ddeESS'
639 when it starts an S language process. We recommend other specific
640 values for S language processes that ESS does not start.
642 User may click on a word or region and then choose from the
643 menu to display the item, or a summary, or a plot, etc.
644 This feature is still under development.
646 (some from Stephen Eglen).
648 <li>XEmacs on Win (NT) is better supported.
650 <li>should now work even when imenu is not available (for old XEmacsen).
651 <li><acronym>ESS[SAS]</acronym>: XEmacs-Imenu fix; <kbd>C-TAB</kbd> is globalized along with your
652 function-key definitions, if specified; you can specify your SAS
653 library definitions outside of autoexec.sas for ess-sas-data-view
654 with SAS code placed in the variable ess-sas-data-view-libname,
655 also the dataset name is defaulted to the nearest permanent dataset
656 to point; Speedbar support now works for permanent datasets, please
657 ignore first./last.; new font-locking is now the default with more
658 improvements for font-locking PROCs, macro statements, * ; and %* ;
660 your .log (if it isn't too big); submit remote .sas files accessed
661 with ange-ftp, EFS or Tramp (Kermit is experimental) by setting
662 ess-sas-submit-method to 'sh; ess-sas-submit-command and
663 ess-sas-submit-command-options are buffer-local so you can have
664 local file variable sections at the end of your .sas files to
665 request different executables or specify special options and the
666 local file variables are re-read at submit instead of only at file
667 open so that if you make a change it is picked up immediately;
669 <li>for STATA: font-lock bug fixed.
672 by things such as \code{.}, \code{\link{.}}, \emph{.} etc.
673 <li>new functions (ess-directory-function) and (ess-narrow-to-defun)
675 <li>Re-organized Makefile and fixed a few bugs.
676 </ul>
679 <ul>
682 Templates assist you in writing .bug and .cmd code (.cmd and .log
683 are replaced by .bmd and .bog to avoid emacs extension collisions).
687 <li>Fixes for `ess-smart-underscore' SAS breakage (Rich Heiberger)
688 <li>You can change between PC and Unix, local and global SAS function-key
689 definitions interactively (Rich Heiberger)
691 <li>New and improved SAS syntax highlighting (Rodney Sparapani)
692 To get the new functionality, set ess-sas-run-make-regexp to nil.
695 You must have the library defined in autoexec.sas for it to work.
696 <li>User-friendly defaults for `sas-program', `ess-sas-batch-pre-command'
697 and `ess-sas-batch-post-command' as well Customize support for these
700 <li>Emacs/XEmacs, Unix/Windows issues collectively handled in ess-emcs.el
701 <li>defadvice solves problem of missing *ESS* (thanks to Jeff Mincy)
702 <li>Improved manual a bit by including things that were only in `README'.
703 </ul>
706 <ul>
708 Inserts `ess-S-assign' (customizable " <- "), unless inside string
709 and comments where plain "_" is used instead. (MM)
710 <li>Fixes for longstanding interactive SAS breakage (RMH)
711 </ul>
714 <ul>
715 <li>Documentation for Windows Installation (Rich Heiberger)
716 <li>removal of ess-vars, finalization of customize support (in the
717 sense that there is no more use of ess-vars, but that we need to
718 fix ess-cust) (AJ Rossini)
719 <li>Many small (and large) fixes/contributions (MMaechler)
722 customizable. (MMaechler)
723 </ul>
726 <ul>
727 <li>BUG FIXES
728 <li>Better SAS support
729 </ul>
732 <ul>
733 <li>BUG FIXES
734 </ul>
737 <ul>
738 <li>Yet more fixes to SAS mode, (Rich Heiberger and Rodney Sparapani)
739 <li>Customize support (for most Emacsen which support it) (AJRossini)
740 <li>ARC and ViSta support out of the box, and fixes for XLispStat (AJRossini)
741 </ul>
744 <ul>
745 <li>Version numbering finally all depending on the ./VERSION file,
746 thanks to Martin Maechler.
747 <li>Yet more fixes to SAS mode, thanks to Rich Heiberger.
748 </ul>
751 <ul>
753 Chuck Taylor, and others.
754 <li>More fixes to SAS mode, thanks to Rodney Sparapani
755 and Rich Heiberger.
756 </ul>
759 <ul>
760 <li>More fixes to Stata mode, thanks to
762 <li>fixed bugs in ESS-elsewhere, thanks to many testers
765 <li>Fixes to SAS mode, thanks to Rodney Sparapani
766 </ul>
769 <ul>
770 <li>More fixes to Stata mode
771 <li>primitive generic version of ESS-elsewhere
772 <li>Small fixes to SAS/Stata.
773 </ul>
776 <ul>
777 <li>Stata mode works
778 <li>Literate Data Analysis using Noweb works
779 </ul>
782 <ul>
783 <li>Bug fixes
784 <li>R documentation mode defaults changed
785 </ul>
788 <ul>
789 <li>able to use inferior iESS mode to
790 communicate directly with a running S-Plus 4.x process using the
792 and related key sequences to send lines from the S-mode file to the
794 and transcripts of previous S sessions in ESS Transcript mode. All
795 three modes know the S language, syntax, and indentation patterns and
796 provide the syntactic highlighting that eases the programming tasks.
797 </ul>
799 <!-- node-name, next, previous, up -->
801 <p><hr>
807 </div>
812 The ESS environment is built on the open-source projects of
813 many contributors, dating back nearly 15 years.
814 Doug Bates and Ed Kademan wrote S-mode in 1989 to edit S and Splus
815 files in GNU Emacs. Frank Ritter and Mike Meyer added features,
816 creating version 2. Meyer and David Smith made further contributions,
818 interaction based on Olin Shivers' comint package.
821 Tom Cook added more functionality creating SAS-mode which was
823 to support XEmacs. Together with extensions written by Martin Maechler,
824 this became version 4.7 and supported S, Splus, and R.
825 In 1995, Rossini extended SAS-mode to work with XEmacs.
828 package for statistical programming; the product of this marriage was
829 called ESS version 5.
831 <ul>
832 <li>The multiple process code, and the idea for
835 <li>Thanks to Doug Bates for many useful suggestions.
837 <li>Thanks to Martin Maechler for reporting and fixing bugs, providing many
838 useful comments and suggestions, and for maintaining the S-mode mailing
839 list.
841 <li>Thanks to Frank Ritter for updates from the previous version, the menu
842 code, and invaluable comments on the manual.
844 <li>Thanks to Ken'ichi Shibayama for his excellent indenting code, and many
845 comments and suggestions.
847 <li>Last but definitely not least, thanks to the many beta testers of the
848 S-mode and ESS mailing lists.
849 </ul>
853 <ul>
856 <!-- -->
859 <!-- -->
862 <!-- -->
865 <!-- -->
868 <!-- -->
871 </ul>
873 <!-- node-name, next, previous, up -->
875 <p><hr>
881 </div>
885 <p>The latest released version of ESS is always available on the web at:
889 <!-- There no longer is an anonymous CVS repository for ESS, due to lack of -->
890 <!-- interest, little demand, and problems with security. -->
891 <!-- text below modified from R-admin.texi (thanks to Kurt for the tip). -->
892 <p>The latest development version of ESS is available via
893 <a href="https://svn.R-project.org/ESS/">https://svn.R-project.org/ESS/</a>, the ESS Subversion repository. If
894 you have a Subversion client (see <a href="http://subversion.tigris.org/">http://subversion.tigris.org/</a>),
895 you can download the sources using:
897 </pre>
899 within that directory, `svn update' will bring that directory up to
900 date. Windows-based tools such as TortoiseSVN are also available for
901 downloading the files. Alternatively, you can browse the sources with a
902 web browser at: <a href="https://svn.r-project.org/ESS/trunk">ESS SVN site</a>. However, please use a subversion client instead to minimize the
903 load when retrieving.
905 <p>If you remove other versions of ESS from your emacs load-path, you can
906 then use the development version by adding the following to .emacs:
909 </pre>
910 <p>Note that https is required, and that the SSL certificate for the
911 Subversion server of the R project is
914 - Hostname: svn.r-project.org
916 - Issuer: Department of Mathematics, ETH Zurich, Zurich, Switzerland, CH
918 </pre>
919 <p class="noindent">(currently, there is no “trusted certificate”). You can accept this
920 certificate permanently and will not be asked about it anymore.
922 <!-- node-name, next, previous, up -->
924 <p><hr>
929 </div>
933 <p>If you need to install ESS, read <a href="#Installation">Installation</a> for details on what
934 needs to be done before proceeding to the next chapter.
936 <p>In this manual we use the standard notation for describing the
940 META, EDIT or ALT key, instead press and release the ESC key and then
944 the useful commands are bound to keystrokes for ease of use. Also, the
945 most popular commands are also available through the emacs menubar, and
946 finally, if available, a small subset are provided on the toolbar.
947 Where possible, keybindings are similar to other modes in emacs to
948 strive for a consistent user interface within emacs, regardless of the
949 details of which programming language is being edited, or process being
950 run.
955 be asked for command line options that you wish to invoke the R process
956 with.
958 <p>Emacs is often referred to as a `self-documenting' text editor. This
959 applies to ESS in two ways. First, limited documentation about each ESS
962 in a separate *Help* buffer. Second, a complete list of keybindings
963 that are available in each ESS mode and brief description of that mode
966 <p>Emacs is a versatile editor written in both C and lisp; ESS is written
967 in the Emacs lisp dialect (termed `elisp') and thus benefits from the
968 flexible nature of lisp. In particular, many aspects of ESS behaviour
969 can be changed by suitable customization of lisp variables. This manual
970 mentions some of the most frequent variables. A full list of them
971 however is available by using the Custom facility within emacs. (Type
974 change to customize ESS to your taste, but it is recommended that you
975 defer this section until you are more familiar with ESS.
977 <!-- node-name, next, previous, up -->
979 <p><hr>
985 </div>
990 The following section details those steps necessary to get ESS running
991 on your system.
994 <li><a accesskey="1" href="#Unix-installation">Unix installation</a>: Installing ESS on your Unix system
995 <li><a accesskey="2" href="#Microsoft-Windows-installation">Microsoft Windows installation</a>: Installing ESS on your MS Windows system
996 <li><a accesskey="3" href="#Requirements">Requirements</a>: emacs, Operating Systems and Statistical Packages
997 </ul>
999 <!-- FIXME: the following contains @node s *and* is also included by readme.texi -->
1000 <!-- which does *not* include 'requires.texi' -->
1001 <!-- ==> *must* give node pointer problems! -->
1002 <p>We now discuss installation, which might happen under Unix or
1003 Microsoft Windows. First, we discuss Unix installation.
1006 <p>For Microsoft Windows Installation please skip to the
1010 <p><hr>
1012 Next: <a rel="next" accesskey="n" href="#Microsoft-Windows-installation">Microsoft Windows installation</a>,
1015 </div>
1017 <!-- node-name, next, previous, up -->
1024 <!-- It will contain, -->
1025 <!-- at the end, the tar file @file{ess-VERSION.tar.gz}, and a directory for -->
1026 <!-- the ESS source, which will be termed "the ESS-VERSION source directory". -->
1027 <!-- Note that the .elc files may be installed elsewhere (as specified in the -->
1028 <!-- Makefile) if desired. -->
1030 <li>Retrieve the latest version from
1034 <li>Decompress/unarchive the files from the disribution.
1037 </pre>
1038 <p>The <code>tar</code> command will create the subdirectory <samp><span class="file">ess-VERSION</span></samp> and install
1039 the files there.
1041 <!-- If you are using GNU Emacs 19.29, decompress/unarchive -->
1042 <!-- @file{ESSDIR/ess-VERSION/lisp/19.29.tar.gz}, -->
1043 <!-- read @file{ESSDIR/ess-VERSION/lisp/19.29/README}, follow the instructions -->
1044 <!-- and you might be able to get ESS to work. -->
1045 <!-- @emph{Please note that GNU Emacs 19.29 is no longer supported}. -->
1046 <!-- For a list of supported versions of emacs, see @xref{Requirements}. -->
1047 <li>Edit the file <samp><span class="file">ESSDIR/ess-VERSION/lisp/ess-site.el</span></samp> as explained in the
1048 comments section of that file.
1049 <!-- Installations that are using ESS only for S-Plus -->
1050 <!-- 6.x will probably not need to make any changes. Installations that also -->
1051 <!-- have one or more of (S4, S+3/4/5/6/7, R, SAS, BUGS, XLispStat, Stata) -->
1052 <!-- may need to uncomment corresponding lines in @file{ESSDIR/ess-VERSION/lisp/ess-site.el}. -->
1054 <li> Add the line
1056 </pre>
1057 <p>to your user or system installation file (GNU Emacs uses
1058 <samp><span class="file">$HOME/.emacs</span></samp> and XEmacs uses <samp><span class="file">$HOME/.xemacs/init.el</span></samp> for the
1060 <samp><span class="file">site-init.el</span></samp> and XEmacs uses <samp><span class="file">site-start.el</span></samp> for the system
1061 installation file).
1063 <p>Alternatively, if <samp><span class="file">ess-site.el</span></samp> is in your current <code>load-path</code>, then:
1065 </pre>
1066 <p>to configure emacs for ESS.
1068 <li>That's it! If you are installing just a local copy of ESS for yourself,
1069 ESS is now ready to be used. (The remaining step below is for advanced
1070 installation.) To edit statistical programs, load the files with the
1071 requiste extensions (<samp><span class="file">.sas</span></samp> for SAS, <samp><span class="file">.S</span></samp> for S-PLUS,
1072 <samp><span class="file">.R</span></samp> for R, and <samp><span class="file">.lsp</span></samp> for XLispStat). To start a statistical
1075 <!-- @item -->
1076 <!-- (OPTIONAL) If you are running S-PLUS or R, you might consider -->
1077 <!-- installing the database files. From within emacs, @code{C-x d} to the -->
1078 <!-- directory containing ESS. Now: -->
1079 <!-- @example -->
1080 <!-- M-x S+6 -->
1081 <!-- @end example -->
1082 <!-- to get S running. Once you see the SPLUS prompt, do: -->
1083 <!-- @example -->
1084 <!-- M-x ess-create-object-name-db -->
1085 <!-- @end example -->
1086 <!-- (this will create the file @file{ess-sp6-namedb.el}; if it isn't in the -->
1087 <!-- ESS directory, move it there). -->
1088 <!-- Then, completions will be autoloaded and will not be regenerated for -->
1089 <!-- every session. -->
1090 <!-- For R, do the same, using -->
1091 <!-- @example -->
1092 <!-- M-x R -->
1093 <!-- @end example -->
1094 <!-- and then @code{M-x ess-create-object-name-db} creating -->
1095 <!-- @file{ess-r-namedb.el}; if it isn't in the ESS directory, move it there). -->
1098 <p>If you want to place the compiled files in other locations edit the
1100 <samp><span class="file">Makeconf</span></samp> in the <samp><span class="file">ESSDIR/ess-VERSION</span></samp> directory (if you are
1101 using XEmacs, then see the XEmacs subsection in Section 1 of <samp><span class="file">Makeconf</span></samp>).
1103 <p>You can compile those files by:
1105 </pre>
1106 <p>When that completes successfully, install the compiled files:
1108 </pre>
1109 <!-- This will install the compiled info files and lisp files. If you are an -->
1110 <!-- XEmacs user, then you should be done. If not, then you may have to -->
1111 <!-- edit/create the file @file{dir} that is found in the directory specified -->
1112 <!-- by @code{INFODIR}: see the sample @file{dir} in ESSDIR/ess-VERSION/doc/info. -->
1113 <!-- If @file{dir} does not exist in @code{INFODIR}, then the sample -->
1114 <!-- @file{dir} will be installed. -->
1116 ESS will work best if the XEmacs sumo tarball (all XEmacs packages combined)
1117 has been installed. For more information on installing XEmacs packages, see
1120 <!-- An alternative, if you are running XEmacs and have access to the -->
1121 <!-- XEmacs system directories, would be to place the directory in the -->
1122 <!-- site-lisp directory, and simply type @code{make all} (and copy the -->
1123 <!-- documentation as appropriate). -->
1124 <!-- For GNU Emacs, you would still have to move the files into the top level -->
1125 <!-- site-lisp directory. -->
1126 </ol>
1128 <!-- >>>> FIXME (see comment in ess.texi): error in ``makeinfo readme.texi'' -->
1129 <!-- @node Microsoft Windows installation, , Unix installation, Installation -->
1131 <p><hr>
1134 Previous: <a rel="previous" accesskey="p" href="#Unix-installation">Unix installation</a>,
1137 </div>
1139 <!-- node-name, next, previous, up -->
1143 (see separate instructions above for UNIX See <a href="#Unix-installation">Unix installation</a>.
1148 new directory (for example, <samp><span class="file">c:\emacs\</span></samp>) to hold the distribution.
1149 This directory will be referred to below as "the ESS distribution
1150 directory". It will contain, at the end, a directory for the ESS
1151 source, which will be termed "the ESS-VERSION source directory".
1155 store it in the ESS distribution directory. Be aware that http browsers
1157 other punctuation. Please change the names back to their original form.
1159 <li>Extract all the files from <samp><span class="file">ess-VERSION.zip</span></samp> into the ESS
1160 distribution directory. In Windows Explorer,
1161 you can unpack the archive by double clicking on the folder; you should
1162 then see a new folder called <samp><span class="file">ess-VERSION</span></samp>. Drag that folder into
1163 your ESS distribution directory.
1165 <li>Add the line
1167 </pre>
1168 <p>to your emacs initialization file. (GNU Emacs uses the filename
1170 <samp><span class="file">~/.xemacs/init.el</span></samp> for the initialization file. The tilde is
1171 recognised by emacs as your HOME directory, i.e. the value of your HOME
1172 environment variable.) Replace
1176 <p>After saving your initialization file, ESS is now installed. Start a
1177 new emacs and you should be ready to use ESS. For example, to edit
1178 statistical programs, load the files with the requisite extensions
1180 R, and ".lsp" for XLispStat). One further step is needed if you wish to
1181 run statistical processes, see below.
1183 <li>To run statistical processes under ESS, Windows users will need to make
1184 sure that the directories for the software they will be using is in the
1185 PATH environment variable. On Windows 9x, add lines similar to the
1188 </pre>
1191 Note that the directory containing the program is
1192 added to the PATH, not the program itself. One such line is needed
1193 for each software program. Be sure to use the abbreviation
1195 backslashes "\".
1197 <p>An alternative, for R users, is that rather than adjusting the PATH
1198 variable, you can add the following to your emacs initialization file
1199 (and restart emacs):
1201 </pre>
1203 Change the path otherwise to point to other locations.
1208 </pre>
1209 <p>You will then be
1210 asked for a pathname ("S starting data directory?"), from which to
1211 start the process. The prompt will propose your current directory
1212 as the default. ESS will start the S-PLUS GUI. There will be
1213 slight delay during which emacs is temporarily frozen. ESS will arrange for
1214 communication with the S-PLUS GUI using the DDE protocol.
1215 Send lines or regions
1216 from the emacs buffer containing your S program (for example,
1222 without the S-PLUS GUI:
1225 </pre>
1227 directory?"), from which to start the process. The prompt will
1228 propose your current directory as the default.
1229 You get Unix-like behavior, in particular the entire
1230 transcript is available for emacs-style search commands.
1231 Send lines or regions from the emacs buffer containing your S
1232 program (for example, <samp><span class="file">myfile.s</span></samp>) to the *S+6* buffer with the
1234 Interactive graphics are available with Sqpe by using the java
1235 library supplied with S-PLUS 6.1 and newer releases.
1236 Enter the commands:
1238 java.graph()
1239 </pre>
1241 in several formats, but not PostScript. If you
1242 need a PostScript file you will need to open a separate
1246 <p>To connect to an already running S-PLUS GUI (started, for example,
1247 from the S-PLUS icon):
1249 </pre>
1250 <p>You will then be
1251 asked for a pathname ("S starting data directory?"), from which to
1252 start the process. The prompt will propose your current directory
1253 as the default. ESS will arrange for
1254 communication with the already running S-PLUS GUI using the DDE protocol.
1255 Send lines or regions
1256 from the emacs buffer containing your S program (for example,
1261 <p>If you wish to run R, you can start it with:
1263 </pre>
1264 <p>XLispStat can not currently be run with
1266 </pre>
1267 <p>Hopefully, this will change. However, you can still edit with
1268 emacs, and cut and paste the results into the XLispStat
1269 *Listener* Window under Microsoft Windows.
1271 <!-- SAS for Windows uses the batch access with function keys that is -->
1272 <!-- described in -->
1273 <!-- @file{doc/README.SAS}. -->
1274 <!-- @xref{ESS(SAS)-MS Windows}. -->
1275 <!-- The user can also edit SAS files -->
1276 <!-- in an @code{ESS[SAS]} buffer and than manually copy and paste them into -->
1277 <!-- an Editor window in the SAS Display Manager. -->
1278 <!-- For Windows, inferior SAS in an @code{@iESS{[SAS]}} buffer does not work -->
1279 <!-- on the local machine. It does work over a network connection to -->
1280 <!-- SAS running on a remote Unix computer. -->
1281 <!-- Reason: we use ddeclient to interface with programs and SAS doesn't -->
1282 <!-- provide the corresponding ddeserver capability. -->
1283 <!-- @item -->
1284 <!-- (OPTIONAL) If you are running Sqpe or R, you might consider -->
1285 <!-- installing the database files. From within emacs, @code{C-x d} to -->
1286 <!-- the directory containing ESS. Now: -->
1287 <!-- @example -->
1288 <!-- M-x Sqpe+6 -->
1289 <!-- @end example -->
1290 <!-- to get S running. Once you see the SPLUS prompt, do: -->
1291 <!-- @example -->
1292 <!-- M-x ess-create-object-name-db -->
1293 <!-- @end example -->
1294 <!-- (this will create the file @file{ess-s+6-namedb.el}; if it isn't in the -->
1295 <!-- ESS directory, move it there). -->
1296 <!-- Then, completions will be autoloaded and will not be regenerated -->
1297 <!-- for every session. -->
1298 <!-- For R, do the same, using -->
1299 <!-- @example -->
1300 <!-- M-x R -->
1301 <!-- @end example -->
1302 <!-- and then @code{M-x ess-create-object-name-db} creating -->
1303 <!-- @file{ess-r-namedb.el}; if it isn't in the ESS directory, move it -->
1304 <!-- there). -->
1305 <li>That's it!
1307 </ol>
1308 <!-- Requirements duplicated? -->
1309 <!-- @node Requirements, , Microsoft Windows installation, Installation -->
1310 <!-- node-name, next, previous, up -->
1311 <!-- @section Requirements -->
1312 <!-- @include requires.texi -->
1315 <p><hr>
1317 Previous: <a rel="previous" accesskey="p" href="#Microsoft-Windows-installation">Microsoft Windows installation</a>,
1320 </div>
1322 <!-- node-name, next, previous, up -->
1325 <p>ESS has been tested with
1327 <ul>
1330 <li>S4
1335 </ul>
1337 <p>on the following platforms
1339 <ul>
1340 <li>Linux (all)
1341 <li>Solaris/SunOS (all)
1342 <!-- cannot confirm this right now @item SGI (all) -->
1345 </ul>
1347 <p>with the following versions of emacs
1349 <ul>
1351 <li>XEmacs 21.0, 21.1.13-14, 21.4.0-8, 21.4.9-13<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a>, 21.4.14-15, 21.4.17-18, 21.5.23
1352 <!-- @item GNU Emacs <20.3 and XEmacs <21.0@footnote{These releases of emacs are no -->
1353 <!-- longer supported, so an upgrade is recommended if you plan to use ESS. -->
1354 <!-- If you have GNU Emacs 19.29, see @xref{Unix installation}. Also, note -->
1355 <!-- that the `custom' library bundled with Emacs 19.34 is too _old_, its API is -->
1356 <!-- incompatible with the `new custom' bundled with recent Emacsen. -->
1357 <!-- The `new custom' for Emacs 19.34 is available for download -->
1358 <!-- @uref{ftp://ftp.dina.kvl.dk/pub/Staff/Per.Abrahamsen/custom/custom-1.9962.tar.gz, here}.} -->
1359 </ul>
1361 <!-- node-name, next, previous, up -->
1363 <p><hr>
1369 </div>
1373 <p>As well as using ESS to edit your source files for statistical programs,
1374 you can use ESS to run these statistical programs. In this chapter, we
1375 mostly will refer by example to running S from within emacs. The emacs
1376 convention is to name such processes running under its control as
1377 `inferior processes'. This term can be slightly misleading, in which
1378 case these processes can be thought of `interactive processes'. Either
1379 way, we use the term `iESS' to refer to the Emacs mode used to interact
1380 with statistical programs.
1382 <!-- node-name, next, previous, up -->
1386 <li><a accesskey="3" href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a>
1387 <li><a accesskey="4" href="#S_002belsewhere-and-ESS_002delsewhere">S+elsewhere and ESS-elsewhere</a>
1389 </ul>
1392 <p><hr>
1394 Next: <a rel="next" accesskey="n" href="#Multiple-ESS-processes">Multiple ESS processes</a>,
1398 </div>
1405 <a name="index-ESS-process-directory-13"></a><a name="index-starting-directory-14"></a><a name="index-working-directory-15"></a><a name="index-directories-16"></a>
1406 S will then (by default) ask the question
1408 </pre>
1411 the shell). This directory should have a <samp><span class="file">.Data</span></samp> subdirectory.
1413 <p>You will then be popped into a buffer
1414 <a name="index-ESS-process-buffer-17"></a><a name="index-process-buffer-18"></a>with name `<samp><span class="samp">*S*</span></samp>' which will be used
1415 for interacting with the ESS process, and you can start entering commands.
1417 <!-- node-name, next, previous, up -->
1419 <p><hr>
1421 Next: <a rel="next" accesskey="n" href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a>,
1425 </div>
1430 ESS allows you to run more than one ESS process simultaneously in the
1431 same session. Each process has a name and a number; the initial process
1432 <a name="index-process-names-20"></a>(process 1) is simply named (using S-PLUS as an example) `<samp><span class="samp">S+3:1</span></samp>'.
1433 <!-- You may start a new process by passing a numeric argument to -->
1434 <!-- @kbd{M-x S}. For example, typing @kbd{ESC 2 M-x S} starts up -->
1435 <!-- an ESS process with name @samp{S2}, in a buffer whose name -->
1436 <!-- is initially @samp{*S2*}. -->
1437 The name of the process is shown in the mode line in square brackets
1438 (for example, `<samp><span class="samp">[S+3:2]</span></samp>'); this is useful if the process buffer is
1440 process, using the first available process number. With a prefix
1442 command line options.
1444 <p><a name="index-ess_002drequest_002da_002dprocess-21"></a>You can switch to any active ESS process with the command
1445 `<samp><span class="samp">M-x ess-request-a-process</span></samp>'. Just enter the name of the process
1446 you require; completion is provided over the names of all running S
1447 processes. This is a good command to consider binding to a global key.
1449 <!-- SJE - commented outl the default behaviour now is to label *S* rather -->
1450 <!-- than *S:1*. -->
1451 <!-- @vindex ess-plain-first-buffername -->
1452 <!-- For the predecessor to ESS (S-mode 4.8), the initial process was not -->
1453 <!-- visibly numbered, i.e. S instead of S1 was used in the mode-line. To -->
1454 <!-- obtain this behavior, set the variable @code{ess-plain-first-buffername} -->
1455 <!-- to @code{t}. See @file{ess-site} for how to set this for all users. -->
1456 <!-- node-name, next, previous, up -->
1458 <p><hr>
1460 Next: <a rel="next" accesskey="n" href="#S_002belsewhere-and-ESS_002delsewhere">S+elsewhere and ESS-elsewhere</a>,
1461 Previous: <a rel="previous" accesskey="p" href="#Multiple-ESS-processes">Multiple ESS processes</a>,
1464 </div>
1468 <p><a name="index-Remote-Computers-22"></a><a name="index-ess_002dremote-23"></a><a name="index-ESS_002delsewhere-24"></a><a name="index-S_002belsewhere-25"></a>
1469 ESS works with processes on remote computers as easily as with
1470 processes on the local machine. The recommended way to access a
1471 statistical program on remote computer is to start it from a telnet or
1472 ssh buffer and then connect ESS to that buffer.
1475 <li>Start a new telnet or ssh buffer and connect to the remote computer
1476 (e.g. use `<samp><span class="samp">M-x telnet</span></samp>' or `<samp><span class="samp">M-x ssh</span></samp>'; ssh.el is available at
1477 <a href="ftp://ftp.splode.com/pub/users/friedman/emacs-lisp/ssh.el">ftp://ftp.splode.com/pub/users/friedman/emacs-lisp/ssh.el</a>).
1479 <li>Start the ESS process on the remote machine, for example with one of
1480 the commands `<samp><span class="samp">Splus</span></samp>', or `<samp><span class="samp">R</span></samp>', or `<samp><span class="samp">sas -stdio</span></samp>'.
1482 <li>Enter the ESS command `<samp><span class="samp">M-x ess-remote</span></samp>'. You will be prompted for
1483 a program name. Enter `<samp><span class="samp">sp6</span></samp>' or `<samp><span class="samp">r</span></samp>' or `<samp><span class="samp">sas</span></samp>' or another
1484 valid name. Your telnet process is now known to ESS. All the usual
1485 ESS commands (`<samp><span class="samp">C-c C-n</span></samp>' and its relatives) now work with the S
1486 language processes. For SAS you need to use a different command
1487 `<samp><span class="samp">C-c i</span></samp>' (that is a regular `<samp><span class="samp">i</span></samp>', not a `<samp><span class="samp">C-i</span></samp>') to send
1490 <!-- and lets SAS display them formatted correctly as in a SAS log file. -->
1491 With ess-remote you get teletype behavior—the data input, the
1492 log, and the listing all appear in the same buffer. To make this work,
1493 you need to end every PROC and DATA step with a "RUN;" statement. The
1494 "RUN;" statement is what tells SAS that it should process the preceding
1495 input statements.
1497 <li>Graphics (interactive) on the remote machine. If you run X11
1499 on both the local and remote machines then you should be able to
1500 display the graphs locally by setting the `<samp><span class="samp">DISPLAY</span></samp>' environment
1501 variable appropriately. Windows users can download `<samp><span class="samp">xfree86</span></samp>'
1502 from cygwin.
1504 <li>Graphics (static) on the remote machine.
1505 If you don't run the X window system on the local machine, then you can write
1506 graphics to a file on the remote machine, and display the file in
1507 a graphics viewer on the local machine. Most statistical software can
1508 write one or more of postscript, GIF, or JPEG files.
1509 Depending on the versions of emacs and the operating system that you
1510 are running, emacs itself may display `<samp><span class="samp">.gif</span></samp>' and `<samp><span class="samp">.jpg</span></samp>'
1511 files. Otherwise, a graphics file viewer will be needed.
1512 Ghostscript/ghostview may be downloaded to display `<samp><span class="samp">.ps</span></samp>' and
1513 `<samp><span class="samp">.eps</span></samp>' files. Viewers for GIF and JPEG are usually included with
1514 operating systems. See <a href="#ESS_0028SAS_0029_002d_002dFunction-keys-for-batch-processing">ESS(SAS)–Function keys for batch processing</a>,
1515 for more information on using the F12 key for displaying graphics files
1516 with SAS.
1517 </ol>
1519 <p>Should you or a colleague inadvertently start a statistical process in
1520 an ordinary `<samp><span class="samp">*shell*</span></samp>' buffer, the `<samp><span class="samp">ess-remote</span></samp>' command can
1521 be used to convert it to an ESS buffer and allow you to use the ESS
1522 commands with it.
1524 <p>We have two older commands, now deprecated, for accessing ESS processes
1525 on remote computers.
1528 <!-- node-name, next, previous, up -->
1530 <p><hr>
1534 Previous: <a rel="previous" accesskey="p" href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a>,
1537 </div>
1541 <p>These commands are now deprecated. We recommend `<samp><span class="samp">ess-remote</span></samp>'. We
1542 have two versions of the elsewhere function. `<samp><span class="samp">S+elsewhere</span></samp>' is
1543 specific for the S-Plus program. The more general function
1548 You will be prompted for a starting directory. I usually give it my
1549 project directory on the local machine, say `<samp><span class="samp">~myname/myproject/</span></samp>'
1551 <p>Or enter `<samp><span class="samp">M-x ESS-elsewhere</span></samp>'. You will be prompted for an ESS
1552 program and for a starting directory. I usually give it my project
1553 directory on the local machine, say `<samp><span class="samp">~myname/myproject/</span></samp>'
1555 <li>The `<samp><span class="samp">*S+3*</span></samp>' buffer will appear with a prompt from the
1556 local operating system (the unix prompt on a unix workstation or with
1557 cygwin bash on a PC, or the msdos prompt on a PC without bash). emacs
1558 may freeze because the cursor is at the wrong place. Unfreeze it with
1559 `<samp><span class="samp">C-g</span></samp>' then move the cursor to the end with `<samp><span class="samp">M-></span></samp>'.
1560 With `<samp><span class="samp">S+elsewhere</span></samp>' the buffer name is based on the name of the ESS program.
1561 <li>Enter
1562 `<samp><span class="samp">telnet myname@other.machine</span></samp>' (or `<samp><span class="samp">ssh myname@other.machine</span></samp>').
1563 You will be prompted for your password on the remote machine.
1564 Use
1566 before typing the password itself.
1568 <li>Before starting the ESS process, type `<samp><span class="samp">stty -echo nl</span></samp>'
1570 `<samp><span class="samp">nl</span></samp>' turns off the newline that you see as `<samp><span class="samp">^M</span></samp>'.
1572 <li>You are now talking to the unix prompt on the other machine in the
1573 `<samp><span class="samp">*S+3*</span></samp>' buffer. cd into the directory for the current project and start
1574 the ESS process by entering
1575 `<samp><span class="samp">Splus</span></samp>' or `<samp><span class="samp">R</span></samp>' or `<samp><span class="samp">sas -stdio</span></samp>'
1576 as appropriate. If you can login remotely to your Windows 2000, then
1577 you should be able to run `<samp><span class="samp">Sqpe</span></samp>' on the Windows machine. I haven't
1578 tested this and noone has reported their tests to me. You will not be
1579 able to run the GUI through this text-only connection.
1581 <li>Once you get the S or R or SAS prompt, then you are completely connected.
1582 All the `<samp><span class="samp">C-c C-n</span></samp>' and related commands work correctly in sending
1583 commands from `<samp><span class="samp">myfile.s</span></samp>' or `<samp><span class="samp">myfile.r</span></samp>' on the PC to the
1584 `<samp><span class="samp">*S+3*</span></samp>' buffer running the S or R or SAS program on the remote machine.
1586 <li>Graphics on the remote machine works fine. If you run the X window
1587 system on the remote unix machine you should be able to display them in
1588 `<samp><span class="samp">xfree86</span></samp>' on your PC. If you don't run X11, then you can write
1589 graphics to the postscript device and copy it to your PC with dired and
1590 display it with ghostscript.
1591 </ol>
1593 <!-- node-name, next, previous, up -->
1595 <p><hr>
1597 Previous: <a rel="previous" accesskey="p" href="#S_002belsewhere-and-ESS_002delsewhere">S+elsewhere and ESS-elsewhere</a>,
1600 </div>
1604 <p>If you do not wish ESS to prompt for a starting directory when starting
1606 <a name="index-ess_002dask_002dfor_002dess_002ddirectory-26"></a><code>nil</code>. In this case, the value of the variable <code>ess-directory</code>
1607 <a name="index-ess_002ddirectory-27"></a>is used as the starting directory. The default value for this variable
1614 <p>If you like to keep a record of your S sessions, set the variable
1616 filename for the transcript before the ESS process starts.
1619 — User Option: <b>ess-ask-about-transfile</b><var><a name="index-ess_002dask_002dabout_002dtransfile-28"></a></var><br>
1621 transcript.
1622 </p></blockquote></div>
1624 <p><a name="index-transcript-file-29"></a>Enter the name of a file in which to save the transcript at the prompt.
1625 If the file doesn't exist it will be created (and you should give it a
1626 file name ending in `<samp><span class="samp">.St</span></samp>'); if the file already exists the
1627 transcript will be appended to the file. (Note: if you don't set this
1628 variable but you still want to save the transcript, you can still do it
1631 <p>Once these questions are answered (if they are asked at all) the S
1632 process itself is started by calling the program name specified in the
1634 <a name="index-inferior_002dess_002dprogram-30"></a>If you need to pass any arguments to this program, they may be specified
1638 <a name="index-arguments-to-S-program-31"></a>It is not normally necessary to pass arguments to the S program; in
1639 particular do not pass the `<samp><span class="samp">-e</span></samp>' option to <code>Splus</code>, since ESS
1640 provides its own command history mechanism.
1642 <p>By default, the new process will be displayed in the same window in the
1643 current frame. If you wish your S process to appear in a separate
1646 process to appear within another window of the current frame.
1648 <!-- node-name, next, previous, up -->
1650 <p><hr>
1656 </div>
1660 <p><a name="index-entering-commands-32"></a><a name="index-commands-33"></a><a name="index-sending-input-34"></a>
1661 The primary function of the ESS package is to provide an easy-to-use
1662 front end to the S interpreter. This is achieved by running the S
1663 process from within an Emacs buffer, so that the Emacs editing commands
1664 are available to correct mistakes in commands, etc. The features of
1665 Inferior S mode are similar to those provided by the standard Emacs
1666 shell mode (see <a href="emacs.html#Shell-Mode">Shell Mode</a>). Command-line completion of S objects and a number of `hot
1667 keys' for commonly-used S commands are also provided for ease of
1668 typing.
1671 <li><a accesskey="1" href="#Command_002dline-editing">Command-line editing</a>: Entering commands and fixing mistakes
1673 <li><a accesskey="3" href="#Completion-details">Completion details</a>: Advanced completion concepts
1676 <li><a accesskey="6" href="#History-expansion">History expansion</a>: References to historical commands
1678 <li><a accesskey="8" href="#Statistical-Process-running-in-ESS_003f">Statistical Process running in ESS?</a>
1681 </ul>
1683 <!-- node-name, next, previous, up -->
1685 <p><hr>
1689 Previous: <a rel="previous" accesskey="p" href="#Entering-commands">Entering commands</a>,
1692 </div>
1697 Sending a command to the ESS process is as simple as typing it in
1700 <ul>
1702 <a name="index-inferior_002dess_002dsend_002dinput-36"></a>Send the command on the current line to the ESS process.
1703 </ul>
1706 editing commands are available to correct it (see <a href="emacs.html#Basic">Basic</a>). Once the
1708 cursor is not at the end of the line) to send the corrected command to
1709 the ESS process.
1711 <p>ESS provides some other commands which are useful for fixing mistakes:
1713 <ul>
1715 <a name="index-backward_002dkill_002dword-37"></a>Deletes the previous word (such as an object name) on the command line.
1718 <a name="index-comint_002dkill_002dinput-38"></a>Deletes everything from the prompt to point. Use this to abandon a
1719 command you have not yet sent to the ESS process.
1722 <a name="index-comint_002dbol-39"></a>Move to the beginning of the line, and then skip forwards past the
1723 prompt, if any.
1724 </ul>
1727 commands relevant to entering input.
1729 <!-- node-name, next, previous, up -->
1731 <p><hr>
1734 Previous: <a rel="previous" accesskey="p" href="#Command_002dline-editing">Command-line editing</a>,
1737 </div>
1741 <p><a name="index-completion-of-object-names-40"></a><a name="index-command_002dline-completion-41"></a>
1743 that provided by Shell Mode for filenames. In Inferior S mode,
1748 <ul>
1750 <a name="index-comint_002ddynamic_002dcomplete-42"></a>Complete the S object name or filename before point.
1751 </ul>
1753 <p>When the cursor is just after a partially-completed object name,
1757 instead of file names. ESS maintains a list of all objects known to S
1758 at any given time, which basically consists of all objects (functions
1760 command
1761 <a name="index-search_0028_0029-44"></a>along with the component objects of attached data frames
1764 <p>For example, consider the three functions (available in Splus version
1767 insert the characters `<samp><span class="samp">om</span></samp>', completing the longest prefix
1768 (`<samp><span class="samp">binom</span></samp>') which distinguishes these three commands. Pressing
1770 this prefix, allowing you to add more characters (say, `<samp><span class="samp">.</span></samp>') which
1771 specify the function you desire. After entering more characters
1773 uniqueness, etc. If you just wish to see what completions exist without
1776 <ul>
1778 <a name="index-ess_002dlist_002dobject_002dcompletions-46"></a>List all possible completions of the object name at point.
1779 </ul>
1781 <p>ESS also provides completion over the components of named lists accessed
1782 using the `<samp><span class="samp">$</span></samp>' notation, to any level of nested lists. This feature
1783 is particularly useful for checking what components of a list object
1784 exist while partway through entering a command: simply type the object
1785 name and `<samp><span class="samp">$</span></samp>' and press <kbd>TAB</kbd> to see the names of existing list
1786 components for that object.
1788 <a name="index-completion-on-file-names-49"></a>Completion is also provided over file names, which is particularly
1790 which require fully expanded file names. Whenever the cursor is within
1792 point, and also expands any `<samp><span class="samp">~</span></samp>' or environment variable references.
1794 <p>If the cursor is not in a string and does not follow a (partial) object
1798 <!-- node-name, next, previous, up -->
1800 <p><hr>
1806 </div>
1810 <p>ESS automatically keeps track of any objects added or deleted to the
1811 system (such as new objects created, or directories added to the search
1812 list) to make completion as accurate as possible. Whenever ESS notices
1813 that search list has changed
1814 <a name="index-ess_002dchange_002dsp_002dregexp-50"></a><a rel="footnote" href="#fn-2" name="fnd-2"><sup>2</sup></a> when you attach a directory or data
1815 frame, the objects associated with it immediately become available for a
1816 completion; when it is detached completion is no longer available on
1817 those objects.
1819 <p>To maintain a list of accessible objects for completion, ESS needs to
1820 determine which objects are contained in each directory or data frame on
1821 the search list. This is done at the start of each S session, by
1823 list.
1825 <!-- On some systems, however, this can be rather slow; it's doubly -->
1826 <!-- frustrating when you consider that most of the directories on the search -->
1827 <!-- list are the standard @Sl{} libraries, which never change anyway! When -->
1828 <!-- ESS was installed, a database of the standard object names should have -->
1829 <!-- been created which should speed up this process at the start of an S -->
1830 <!-- session; if it has not been created you will get a warning like -->
1831 <!-- `S-namedb.el does not exist'. @xref{Installation}, for information on -->
1832 <!-- how to create this database. -->
1833 <p>Efficiency in completion is gained by maintaining a cache of objects
1834 currently known to S; when a new object becomes available or is deleted,
1835 only one component of the cache corresponding to the associated
1836 directory needs to be refreshed. If ESS ever becomes confused about
1837 what objects are available for completion (such as when if refuses to
1839 ess-resynch</kbd>
1840 <a name="index-ess_002dresynch-51"></a>forces the <em>entire</em> cache to be refreshed, which should fix the
1841 problem.
1843 <!-- node-name, next, previous, up -->
1845 <p><hr>
1848 Previous: <a rel="previous" accesskey="p" href="#Completion-details">Completion details</a>,
1851 </div>
1855 <p>Most of the time, the cursor spends most of its time at the bottom of
1856 the ESS process buffer, entering commands. However all the input
1857 and output from the current (and previous) ESS sessions is stored in
1858 the process buffer (we call this the transcript) and often we want to
1859 <a name="index-transcript-52"></a>move back up through the buffer, to look at the output from previous
1860 commands for example.
1862 <p>Within the process buffer, a paragraph
1863 <a name="index-paragraphs-in-the-process-buffer-53"></a>is defined as the prompt, the command after the prompt, and the output
1865 forwards, respectively, through commands in the transcript. A
1867 will allow you to mark a command and its entire output (for deletion,
1868 perhaps). For more information about paragraph commands,
1871 <p>If an ESS process finishes and you restart it in the same process
1872 buffer, the output from the new ESS process appears after the output
1873 from the first ESS process separated by a form-feed (`<samp><span class="samp">^L</span></samp>')
1874 character. Thus pages in the ESS
1875 <a name="index-pages-in-the-process-buffer-54"></a>process buffer correspond to ESS sessions. Thus, for example, you may
1877 ESS sessions in a single ESS process buffer. For more information about
1881 <li><a accesskey="1" href="#Last-command">Last command</a>: Manipulating the output from the last command
1882 <li><a accesskey="2" href="#Process-buffer-motion">Process buffer motion</a>: Viewing older commands
1883 <li><a accesskey="3" href="#Transcript-resubmit">Transcript resubmit</a>: Re-submitting commands from the transcript
1884 <li><a accesskey="4" href="#Saving-transcripts">Saving transcripts</a>: Keeping a record of your S session
1885 </ul>
1887 <!-- node-name, next, previous, up -->
1889 <p><hr>
1891 Next: <a rel="next" accesskey="n" href="#Process-buffer-motion">Process buffer motion</a>,
1895 </div>
1899 <p>Viewing the output of the command you have just entered is a common
1900 occurrence and ESS provides a number of facilities for doing this.
1901 <!-- Within the ESS process buffer, the variable @code{scroll-step} -->
1902 <!-- @vindex scroll-step -->
1903 <!-- is set to 4 (you can redefine this using @code{inferior-ess-mode-hook} -->
1904 <!-- @vindex inferior-ess-hook -->
1905 <!-- if you wish - @pxref{Hooks},) so that the cursor is usually near the -->
1906 <!-- bottom of the window. -->
1907 Whenever a command produces a longish output, it is possible that the
1908 window will scroll, leaving the next prompt near the middle of the
1909 window. The first part of the command output may have scrolled off the
1910 top of the window, even though the entire output would fit in the window
1911 if the prompt were near the bottom of the window. If this happens, you
1912 can use the command
1914 <ul>
1916 <a name="index-comint_002dshow_002dmaximum_002doutput-55"></a>Move to the end of the buffer, and place cursor on bottom line of
1917 window.
1918 </ul>
1921 automatically for all inputs, set the variable
1924 <p>If the first part of the output is still obscured, use
1926 <ul>
1928 <a name="index-comint_002dshow_002doutput-57"></a>Moves cursor to the previous command line and and places it at the top
1929 of the window.
1930 </ul>
1933 altogether, use
1935 <ul>
1937 <a name="index-comint_002dkill_002doutput-58"></a><a name="index-deleting-output-59"></a>Deletes everything from the last command to the current prompt.
1938 </ul>
1941 more manageable size.
1943 <!-- node-name, next, previous, up -->
1945 <p><hr>
1951 </div>
1955 <p>If you want to view the output from more historic commands than the
1956 previous command, commands are also provided to move backwards and
1957 forwards through previously entered commands in the process buffer:
1959 <ul>
1961 <a name="index-comint_002dprevious_002dinput-60"></a>Moves point to the preceding command in the process buffer.
1964 <a name="index-comint_002dnext_002dinput-61"></a>Moves point to the next command in the process buffer.
1965 </ul>
1967 <p class="noindent">Note that these two commands are analogous to <kbd>C-p</kbd> and <kbd>C-n</kbd>
1968 but apply to command lines rather than text lines. And just like
1971 commands are also discussed in <a href="emacs.html#Shell-History-Copying">Shell History Copying</a>.)
1973 <p>There are also two similar commands (not bound to any keys by default)
1974 which move to preceding or succeeding commands, but which first prompt
1975 for a regular expression (see <a href="emacs.html#Regexps">Syntax of Regular Expression</a>), and then moves to
1976 the next (previous) command matching the pattern.
1978 <ul>
1980 <a name="index-comint_002dbackward_002dmatching_002dinput-62"></a><code>(comint-forward-matching-input regexp arg)</code> <br>
1981 <a name="index-comint_002dforward_002dmatching_002dinput-63"></a>Search backward (forward) through the transcript buffer for the
1984 </ul>
1986 <!-- node-name, next, previous, up -->
1988 <p><hr>
1991 Previous: <a rel="previous" accesskey="p" href="#Process-buffer-motion">Process buffer motion</a>,
1994 </div>
1998 <p>When moving through the transcript, you may wish to re-execute some of
1999 the commands you find there. ESS provides three commands to do this;
2000 these commands may be used whenever the cursor is within a command line
2003 key.
2005 <ul>
2007 <a name="index-inferior_002dess_002dsend_002dinput-64"></a>Copy the command under the cursor to the current command line, and
2008 execute it.
2011 <a name="index-comint_002dcopy_002dold_002dinput-65"></a>Copy the command under the cursor to the current command line, but don't
2012 execute it. Leaves the cursor on the command line so that the copied
2013 command may be edited.
2016 <a name="index-ess_002dtranscript_002dsend_002dcommand_002dand_002dmove-66"></a>Copy the command under the cursor to the current command line, and
2017 execute it. Moves the cursor to the following command.
2018 </ul>
2022 line containing a command that you entered (i.e. a line beginning with a
2023 prompt) sends that command to the ESS process once again. If you
2025 it copies the command to the current prompt but does not execute it,
2026 allowing you to edit it before submitting it.
2028 <p>These two commands leave the cursor at the new command line, allowing
2029 you to continue with interactive use of S. If you wish to resubmit a
2031 instead, which leaves the cursor at the command line following the one
2033 re-submit a whole series of commands.
2035 <p>These commands work even if if the current line is a continuation line
2036 (i.e. the prompt is `<samp><span class="samp">+</span></samp>' instead of `<samp><span class="samp">></span></samp>') — in this case all
2037 the lines that form the multi-line command are concatenated together and
2038 the resulting command is sent to the ESS process (currently this is
2039 the only way to resubmit a multi-line command to the ESS process in
2040 one go). If the current line does
2041 <a name="index-multi_002dline-commands_002c-resubmitting-67"></a>not begin with a prompt, an error is signalled. This feature, coupled
2042 with the command-based motion commands described above, could be used as
2043 a primitive history mechanism. ESS provides a more sophisticated
2046 <!-- node-name, next, previous, up -->
2048 <p><hr>
2050 Previous: <a rel="previous" accesskey="p" href="#Transcript-resubmit">Transcript resubmit</a>,
2053 </div>
2057 <p>To keep a record of your S session in a disk file, use the Emacs
2059 ESS process buffer. The name of the process buffer will (probably)
2060 change to the name of the file, but this is not a problem. You can
2061 still use S as usual; just remember to save the file before you quit
2063 which to save the transcript every time you start S by setting the
2064 variable
2065 <a name="index-ess_002dask_002dabout_002dtransfile-68"></a><code>ess-ask-about-transfile</code> to <code>t</code>; see <a href="#Customizing-startup">Customizing startup</a>.
2066 <a name="index-transcript-file-names-69"></a>We recommend you save your transcripts with filenames that end in
2067 `<samp><span class="samp">.St</span></samp>'. There is a special mode (ESS transcript mode —
2069 automatically selected for files with this suffix.
2071 <p><a name="index-editing-transcripts-70"></a>S transcripts can get very large, so some judicious editing is
2073 a command produces excessively long output (printing large arrays, for
2074 example). Delete erroneous commands (and the resulting error messages
2075 or other output) by moving to the command (or its output) and typing
2077 may be used for commands whose output you do not wish to appear in the
2078 transcript. These suggestions are appropriate even if you are not
2079 saving your transcript to disk, since the larger the transcript, the
2080 more memory your Emacs process will use on the host machine.
2082 <p>Finally, if you intend to produce S source code (suitable for using
2085 be of use.
2086 <a name="index-ess_002dtranscript_002dclean_002dregion-71"></a>This command works in any Emacs buffer, and removes all prompts and
2087 command output from an ESS transcript within the current region, leaving
2088 only the commands. Don't forget to remove any erroneous commands first!
2090 <!-- node-name, next, previous, up -->
2092 <p><hr>
2098 </div>
2102 <p><a name="index-command-history-72"></a><a name="index-editing-commands-73"></a><a name="index-re_002dexecuting-commands-74"></a>
2103 ESS provides easy-to-use facilities for re-executing or editing previous
2104 commands. An input history of the last few commands is maintained (by
2105 default the last 50 commands are stored, although this can be changed by
2107 <a name="index-comint_002dinput_002dring_002dsize-75"></a><code>inferior-ess-mode-hook</code>.) The simplest history commands simply
2108 select the next and previous commands in the input history:
2110 <ul>
2112 <a name="index-comint_002dprevious_002dinput-76"></a>Select the previous command in the input history.
2116 </ul>
2118 <p class="noindent">For example, pressing <kbd>M-p</kbd> once will re-enter the last command into
2119 the process buffer after the prompt but does not send it to the ESS
2120 process, thus allowing editing or correction of the command before the
2121 ESS process sees it. Once corrections have been made, press
2124 <p>If you want to select a particular command from the history by matching
2125 it against a regular expression (see <a href="emacs.html#Regexps">Syntax of Regular Expression</a>), to search for a
2126 particular variable name for example, these commands are also available:
2128 <ul>
2130 <a name="index-comint_002dprevious_002dmatching_002dinput-78"></a>Prompt for a regular expression, and search backwards through the input
2131 history for a command matching the expression.
2134 <a name="index-comint_002dnext_002dmatching_002dinput-79"></a>Prompt for a regular expression, and search backwards through the input
2135 history for a command matching the expression.
2136 </ul>
2139 particular sequence of characters; the following two commands provide an
2140 easy way to do this:
2142 <ul>
2144 <a name="index-comint_002dprevious_002dmatching_002dinput_002dfrom_002dinput-80"></a>Select the previous command in the history which matches the string
2145 typed so far.
2148 <a name="index-comint_002dnext_002dmatching_002dinput_002dfrom_002dinput-81"></a>Select the next command in the history which matches the string typed so
2149 far.
2150 </ul>
2153 instead select commands starting with those characters already entered.
2157 in which case it may be a good idea to bind these commands to some other
2158 keys.)
2160 <p>See <a href="emacs.html#Shell-Ring">Shell History Ring</a>, for a more detailed discussion of the history mechanism.
2162 <!-- node-name, next, previous, up -->
2164 <p><hr>
2170 </div>
2174 <p>Instead of searching through the command history using the command
2175 described in the previous section, you can alternatively refer to a
2176 historical command directly using a notation very similar to that used
2177 in <code>csh</code>. History references are introduced by a `<samp><span class="samp">!</span></samp>' or
2180 <dl>
2183 <br><dt>`<samp><span class="samp">!-</span><var>N</var></samp>'<dd>The <var>N</var>th previous command
2185 <br><dt>`<samp><span class="samp">!text</span></samp>'<dd>The last command beginning with the string `<samp><span class="samp">text</span></samp>'
2187 <br><dt>`<samp><span class="samp">!?text</span></samp>'<dd>The last command containing the string `<samp><span class="samp">text</span></samp>'
2188 </dl>
2192 sequence of characters separated by whitespace. (You can modify this
2194 to a list of characters that are allowed to separate words and
2195 <a name="index-comint_002ddelimiter_002dargument_002dlist-82"></a>themselves form words.) Words are numbered beginning with zero. The
2196 word designator usually begins with a `<samp><span class="samp">:</span></samp>' (colon) character;
2197 however it may be omitted if the word reference begins with a `<samp><span class="samp">^</span></samp>',
2198 `<samp><span class="samp">$</span></samp>', `<samp><span class="samp">*</span></samp>' or `<samp><span class="samp">-</span></samp>'. If the word is to be selected from the
2199 previous command, the second `<samp><span class="samp">!</span></samp>' character can be omitted from the
2200 event specification. For instance, `<samp><span class="samp">!!:1</span></samp>' and `<samp><span class="samp">!:1</span></samp>' both
2201 refer to the first word of the previous command, while `<samp><span class="samp">!!$</span></samp>' and
2202 `<samp><span class="samp">!$</span></samp>' both refer to the last word in the previous command. The
2203 format of word designators is as follows:
2205 <dl>
2206 <dt>`<samp><span class="samp">0</span></samp>'<dd>The zeroth word (i.e. the first one on the command line)
2210 <br><dt>`<samp><span class="samp">^</span></samp>'<dd>The first word (i.e. the second one on the command line)
2214 <br><dt>`<samp><var>x</var><span class="samp">-</span><var>y</var></samp>'<dd>A range of words; `<samp><span class="samp">-</span><var>y</var></samp>' abbreviates `<samp><span class="samp">0-</span><var>y</var></samp>'
2216 <br><dt>`<samp><span class="samp">*</span></samp>'<dd>All the words except the zeroth word, or nothing if the command had just
2217 one word (the zeroth)
2221 <br><dt>`<samp><var>x</var><span class="samp">-</span></samp>'<dd>Like `<samp><var>x</var><span class="samp">*</span></samp>', but omitting the last word
2222 </dl>
2224 <p>In addition, you may surround the entire reference except for the first
2225 `<samp><span class="samp">!</span></samp>' by braces to allow it to be followed by other (non-whitespace)
2226 characters (which will be appended to the expanded reference).
2228 <p>Finally, ESS also provides quick substitution; a reference like
2229 `<samp><span class="samp">^old^new^</span></samp>' means “the last command, but with the first occurrence
2230 of the string `<samp><span class="samp">old</span></samp>' replaced with the string `<samp><span class="samp">new</span></samp>'” (the last
2231 `<samp><span class="samp">^</span></samp>' is optional). Similarly, `<samp><span class="samp">^old^</span></samp>' means “the last
2232 command, with the first occurrence of the string `<samp><span class="samp">old</span></samp>' deleted”
2235 <p>To convert a history reference as described above to an input suitable
2238 (otherwise it would try to complete an object name) and not be within a
2239 string (otherwise it would try to complete a filename). So to expand
2241 history reference into an S command from the history, which you can
2244 <p>For example, to execute the last command that referenced the variable
2247 <!-- node-name, next, previous, up -->
2249 <p><hr>
2251 Next: <a rel="next" accesskey="n" href="#Statistical-Process-running-in-ESS_003f">Statistical Process running in ESS?</a>,
2252 Previous: <a rel="previous" accesskey="p" href="#History-expansion">History expansion</a>,
2255 </div>
2259 <p>ESS provides a number of commands for executing the commonly used
2260 functions. These commands below are basically information-gaining
2262 clutter up your transcript and for this reason some of the hot keys
2263 display their output in a temporary buffer instead of the process buffer
2264 by default. This behavior is controlled by the variable
2266 <a name="index-ess_002dexecute_002din_002dprocess_002dbuffer-83"></a>non-<code>nil</code>, means that these commands will produce their output in
2267 the process buffer instead. In any case, passing a prefix argument to
2270 will be displayed in the process buffer if it usually goes to a
2271 temporary buffer, and vice-versa. These are the hot keys that behave in
2272 this way:
2274 <ul>
2277 <a name="index-objects_0028_0029-85"></a>command to the ESS process. A prefix argument specifies the
2278 position on the search list (use a negative argument to toggle
2280 objects are in your working directory.
2288 </ul>
2291 command in anyway, but it proves useful for `spot' calculations which
2292 would otherwise clutter your transcript, or for evaluating an expression
2293 while partway through entering a command. You can also use this command
2294 to generate new hot keys using the Emacs keyboard macro facilities;
2298 to decide where to display the output — they either always display in
2299 the process buffer or in a separate buffer, as indicated:
2301 <ul>
2303 <a name="index-ess_002dexecute_002dattach-95"></a>Prompts for a directory to attach to the ESS process with the
2305 <a name="index-attach_0028_0029-96"></a>If a numeric prefix argument is given it is used as the position on the
2306 search list to attach the directory; otherwise the S default of 2 is
2308 process buffer.
2311 <a name="index-ess_002dload_002dfile-97"></a>Prompts for a file to load into the ESS process using
2314 <a name="index-ess_002dparse_002derrors-98"></a>See <a href="#Error-Checking">Error Checking</a>, for more details.
2318 details.
2321 <a name="index-quitting-from-ESS-99"></a><a name="index-killing-the-ESS-process-100"></a>Sends the <code>q()</code>
2323 <a name="index-exit_0028_0029-102"></a>to the <b>XLS</b> process), and cleans up any temporary buffers (such as
2324 help buffers or edit buffers) you may have created along the way. Use
2325 this command when you have finished your S session instead of simply
2328 <a name="index-ess_002dcleanup-103"></a><a name="index-cleaning-up-104"></a><a name="index-temporary-buffers_002c-killing-105"></a><a name="index-killing-temporary-buffers-106"></a>command explicitly to make sure that all the files that need to be saved
2329 have been saved, and that all the temporary buffers have been killed.
2330 </ul>
2332 <!-- node-name, next, previous, up -->
2334 <p><hr>
2341 </div>
2345 <p><a name="index-STERM-107"></a><a name="index-STERM-108"></a>For the S languages (S, S-Plus, R) ESS sets an option in the current
2346 process that programs in the language can check to determine the
2347 environment in which they are currently running.
2349 <p>ESS sets
2351 inferior <code>i<acronym>ESS[S]</acronym><!-- /@w --></code> or <code>i<acronym>ESS[R]</acronym><!-- /@w --></code> buffer.
2353 <p>ESS sets
2355 processes running in the GUI and communicating with ESS via
2356 the DDE (Microsoft Dynamic Data Exchange) protocol through a
2361 <ul>
2368 </ul>
2370 <p>Additional values may be recommended in the future as new interaction
2372 ESS can't set these other values since the S language program is not
2373 under the control of ESS.
2375 <!-- node-name, next, previous, up -->
2377 <p><hr>
2380 Previous: <a rel="previous" accesskey="p" href="#Statistical-Process-running-in-ESS_003f">Statistical Process running in ESS?</a>,
2383 </div>
2388 When starting R or S under Unix, ESS sets
2390 use gnuclient.exe rather than emacsclient, but the same principle
2391 applies.) Within your R session, for example, if you have a function
2393 function in a temporary Emacs buffer. You can then correct the
2394 function. When you kill the buffer, the definition of the function is
2398 Emacs buffer.
2400 <!-- node-name, next, previous, up -->
2402 <p><hr>
2407 </div>
2411 <p>The following commands are also provided in the process buffer:
2413 <ul>
2415 <a name="index-comint_002dinterrupt_002dsubjob-110"></a>Sends a Control-C signal to the ESS process. This has the effect of
2416 <a name="index-aborting-S-commands-111"></a><a name="index-interrupting-S-commands-112"></a>aborting the current command.
2419 <a name="index-ess_002dabort-113"></a><a name="index-comint_002dstop_002dsubjob-114"></a>Sends a STOP signal to the ESS process, killing it immediately.
2422 cleanly. This command is provided as a safety to
2427 <a name="index-ess_002ddump_002dobject_002dinto_002dedit_002dbuffer-117"></a>Prompts for an object to be edited in an edit buffer. See <a href="#Editing">Editing</a>.
2428 </ul>
2430 <p>Other commands available in Inferior S mode are discussed in
2433 <!-- node-name, next, previous, up -->
2435 <p><hr>
2438 Previous: <a rel="previous" accesskey="p" href="#Entering-commands">Entering commands</a>,
2441 </div>
2445 <p>Inferior S mode records the transcript (the list of all commands
2446 executed, and their output) in the process buffer, which can be saved as
2448 <samp><span class="file">.St</span></samp>. The most obvious use for a transcript file is as a static
2449 record of the actions you have performed in a particular S session.
2450 Sometimes, however, you may wish to re-execute commands recorded in the
2451 transcript file by submitting them to a running ESS process. This
2452 is what Transcript Mode is for.
2454 <p>If you load file a with the suffix <samp><span class="file">.St</span></samp> into Emacs, it is placed
2455 in S Transcript Mode. Transcript Mode is similar to Inferior S mode
2457 <a name="index-transcript-mode-motion-118"></a><a name="index-motion-in-transcript-mode-119"></a>paragraphs are defined as a command and its output, and you can move
2462 <li><a accesskey="1" href="#Resubmit">Resubmit</a>: Resubmitting commands from the transcript file
2464 </ul>
2466 <!-- node-name, next, previous, up -->
2468 <p><hr>
2474 </div>
2478 <p>Three commands are provided to re-submit command lines from the
2479 transcript file to a running ESS process. They are:
2481 <ul>
2483 Send the current command line to the ESS process, and execute it.
2486 Copy the current command to the ESS process, and switch to the
2487 ESS process buffer (ready to edit the copied command).
2490 Send the current command to the ESS process, and move to the next
2491 command line. This command is useful for submitting a series of
2492 commands.
2493 </ul>
2496 Inferior S Mode. In all three cases, the commands should be
2497 executed when the cursor is on a command line in the transcript; the
2498 prompt is automatically removed before the command is submitted.
2500 <!-- node-name, next, previous, up -->
2502 <p><hr>
2507 </div>
2511 <p>Yet another use for transcript files is to extract the command lines for
2512 inclusion in an S source file or function. Transcript mode provides
2513 one command which does just this:
2515 <ul>
2517 Deletes all prompts and command output in the region, leaving only the
2518 commands themselves.
2519 </ul>
2522 buffer for inclusion in a function definition, or may be evaluated
2523 directly (see <a href="#Evaluating-code">Evaluating code</a>) using the code evaluation commands
2524 from S mode, also available in S Transcript Mode.
2526 <!-- node-name, next, previous, up -->
2528 <p><hr>
2534 </div>
2540 <li><a accesskey="2" href="#iESS_0028S_0029_002d_002dInferior-ESS-processes">iESS(S)--Inferior ESS processes</a>
2541 <li><a accesskey="3" href="#ESS_002dhelp_002d_002dassistance-with-viewing-help">ESS-help--assistance with viewing help</a>
2542 <li><a accesskey="4" href="#Philosophies-for-using-ESS_0028S_0029">Philosophies for using ESS(S)</a>
2543 <li><a accesskey="5" href="#Scenarios-for-use-_0028possibilities_002d_002dbased-on-actual-usage_0029">Scenarios for use (possibilities--based on actual usage)</a>
2544 <li><a accesskey="6" href="#Customization-Examples-and-Solutions-to-Problems">Customization Examples and Solutions to Problems</a>
2545 </ul>
2548 <p><hr>
2551 Next: <a rel="next" accesskey="n" href="#iESS_0028S_0029_002d_002dInferior-ESS-processes">iESS(S)--Inferior ESS processes</a>,
2554 </div>
2556 <!-- node-name, next, previous, up - don't use @ESS .. -->
2561 <ul>
2562 <li> proper indenting, generated by both [Tab] and [Return].
2563 <li> color and font choices based on syntax.
2564 <li> ability to send the contents of an entire buffer, a highlighted
2565 region, an S function, or a single line to an inferior S process, if
2566 one is currently running.
2567 <li> ability to switch between processes which would be the target of the
2568 buffer (for the above).
2569 <li> The ability to request help from an S process for variables and
2570 functions, and to have the results sent into a separate buffer.
2571 <li> completion of object names and file names.
2572 </ul>
2575 the suffices found in ess-site (*.R, *.S, *.s, etc). However, one
2576 will have to start up an inferior process to take advantage of the
2577 interactive features.
2580 <p><hr>
2583 Next: <a rel="next" accesskey="n" href="#ESS_002dhelp_002d_002dassistance-with-viewing-help">ESS-help--assistance with viewing help</a>,
2584 Previous: <a rel="previous" accesskey="p" href="#ESS_0028S_0029_002d_002dEditing-files">ESS(S)--Editing files</a>,
2587 </div>
2589 <!-- node-name, next, previous, up -->
2592 <p>iESS (inferior ESS) is the mode for interfacing with active
2593 statistical processes (programs). This mode handles:
2595 <ul>
2596 <li> proper indenting, generated by both [Tab] and [Return].
2597 <li> color and font highlighting based on syntax.
2598 <li> ability to resubmit the contents of a multi-line command
2599 to the executing process with a single keystroke [RET].
2600 <li> The ability to request help from the current process for variables
2601 and functions, and to have the results sent into a separate buffer.
2602 <li> completion of object names and file names.
2603 <li> interactive history mechanism.
2604 <li> transcript recording and editing.
2605 </ul>
2607 <p>To start up iESS mode, use:
2609 M-x S4
2610 M-x S+5
2611 M-x S+6
2612 M-x R
2613 </pre>
2615 you have access to each). Usually the site will have defined one of
2616 these programs (by default S+6) to the simpler name:
2618 <p>M-x S
2620 <p>In the (rare) case that you wish to pass command line arguments to the
2623 <p>Note that R has some extremely useful command line arguments. For
2625 files. To enter a command line argument, call R using a "prefix
2626 argument", by
2628 <p>C-u M-x R
2635 wish to always call R with certain arguments, set the variable
2638 <!-- Menubar access to other versions of R and Sqpe -->
2639 <p>If you have other versions of R or S-Plus available on the system, ESS
2640 is also able to start those versions. How this works depend on which OS
2641 you are using:
2643 <p>R on Unix systems:
2644 If you have "R-1.8.1" on
2647 versions of R are called other names, consider renaming them with a
2649 which defuns have been created for starting different versions of R,
2651 for particular versions of R have been created. These other versions of
2652 R can also be started from the "ESS->Start Process->Other" menu.
2654 <p>R on Windows systems:
2655 If you have "rw1081" on
2657 default, ESS will find versions of R located in directories
2659 versions of R are called other names, you will need to change the variable
2661 which defuns have been created for starting different versions of R,
2663 for particular versions of R have been created. These other versions of
2664 R can also be started from the "ESS->Start Process->Other" menu.
2668 executables beginning "Splus" on your path. If your versions of S are
2669 called other names, consider renaming them with a symbolic link or
2671 been created for starting different versions of Splus, type <kbd>M-x
2672 Splus</kbd> and then hit [Tab]. You will then see if any defuns for
2673 particular versions of Splus have been created. These other versions of
2674 Splus can also be started from the "ESS->Start Process->Other" menu.
2676 <p>A second mechanim is also available for running other versions of Splus.
2678 should be of the form: (DEFUN-NAME PATH ARGS). DEFUN-NAME is the name
2679 of the new emacs function you wish to create to start the new S process;
2680 PATH is the full path to the version of S you want to run; ARGS is an
2681 optional string of command-line arguments to pass to the S process.
2682 Here is an example setting:
2686 </pre>
2688 with the corresponding command line arguments.
2692 ess-site is loaded, since the new emacs functions are created when ESS
2693 is loaded.
2695 <p>Sqpe (S-Plus running inside an emacs buffer) on Windows systems:
2696 If you have an older version of S-Plus (S-Plus 6.1 for example) on your system,
2698 default, ESS will find versions of S-Plus located in the installation
2699 directories that Insightful uses by default. If your
2700 versions of S-Plus are anywhere else, you will need to change the variable
2702 which defuns have been created for starting different versions of S-Plus,
2704 for particular versions of S-Plus have been created. These other versions of
2705 S-Plus can also be started from the "ESS->Start Process->Other" menu.
2708 <p><hr>
2711 Next: <a rel="next" accesskey="n" href="#Philosophies-for-using-ESS_0028S_0029">Philosophies for using ESS(S)</a>,
2712 Previous: <a rel="previous" accesskey="p" href="#iESS_0028S_0029_002d_002dInferior-ESS-processes">iESS(S)--Inferior ESS processes</a>,
2715 </div>
2717 <!-- node-name, next, previous, up -->
2723 <p><hr>
2726 Next: <a rel="next" accesskey="n" href="#Scenarios-for-use-_0028possibilities_002d_002dbased-on-actual-usage_0029">Scenarios for use (possibilities--based on actual usage)</a>,
2727 Previous: <a rel="previous" accesskey="p" href="#ESS_002dhelp_002d_002dassistance-with-viewing-help">ESS-help--assistance with viewing help</a>,
2730 </div>
2734 <p>The first is preferred, and configured for. The second one can be
2735 retrieved again, by changing emacs variables.
2738 real. The objects are realizations of the source code. Source
2739 for EVERY user modified object is placed in a particular directory
2740 or directories, for later editing and retrieval.
2743 realization of the objects. Dumped buffers should not be saved.
2744 _We_strongly_discourage_this_approach_. However, if you insist,
2745 add the following lines to your .emacs file:
2747 (setq ess-delete-dump-files t)
2748 (setq ess-mode-silently-save nil)
2749 </pre>
2750 <p>The second saves a small amount of disk space. The first allows for
2751 better portability as well as external version control for code.
2754 <p><hr>
2757 Next: <a rel="next" accesskey="n" href="#Customization-Examples-and-Solutions-to-Problems">Customization Examples and Solutions to Problems</a>,
2758 Previous: <a rel="previous" accesskey="p" href="#Philosophies-for-using-ESS_0028S_0029">Philosophies for using ESS(S)</a>,
2761 </div>
2765 <p>We present some basic suggestions for using ESS to interact with S.
2766 These are just a subset of approaches, many better approaches are
2767 possible. Contributions of examples of how you work with ESS are
2768 appreciated (especially since it helps us determine priorities on
2769 future enhancements)! (comments as to what should be happening are
2770 prefixed by "##").
2772 ## Load the file you want to work with
2773 C-x C-f myfile.s
2775 ## Edit as appropriate, and then start up S-PLUS 3.x
2776 M-x S+3
2781 ## Split the screen and go back to the file editing buffer.
2782 C-x 2 C-x b myfile.s
2784 ## Send regions, lines, or the entire file contents to S-PLUS. For regions,
2785 ## highlight a region with keystrokes or mouse and then send with:
2786 C-c C-r
2788 ## Re-edit myfile.s as necessary to correct any difficulties. Add
2789 ## new commands here. Send them to S by region with C-c C-r, or
2790 ## one line at a time with C-c C-n.
2792 ## Save the revised myfile.s with C-x C-s.
2795 ## will be prompted for a file name. The recommended name is
2796 ## myfile.St. With the *.St suffix, the file will come up in ESS
2797 ## Transcript mode the next time it is accessed from Emacs.
2801 2: ## Program revision example (source code is real)
2804 M-x S+3
2806 ## Load the file you want to work with
2807 C-x C-f myfile.s
2809 ## edit program, functions, and code in myfile.s, and send revised
2810 ## functions to S when ready with
2811 C-c C-f
2812 ## or highlighted regions with
2813 C-c C-r
2814 ## or individual lines with
2815 C-c C-n
2816 ## or load the entire buffer with
2817 C-c C-l
2819 ## save the revised myfile.s when you have finished
2820 C-c C-s
2824 3: ## Program revision example (S object is real)
2827 M-x S+3
2829 ## Dump an existing S object my.function into a buffer to work with
2830 C-c C-d my.function
2831 ## a new buffer named yourloginname.my.function.S will be created with
2832 ## an editable copy of the object. The buffer is associated with the
2833 ## pathname /tmp/yourloginname.my.function.S and will amlost certainly not
2834 ## exist after you log off.
2836 ## enter program, functions, and code into work buffer, and send
2837 ## entire contents to S-PLUS when ready
2838 C-c C-b
2841 ## the results.
2842 C-c C-y
2845 ## Return to the work buffer (may/may not be prefixed)
2846 C-x C-b yourloginname.my.function.S
2847 ## Fix the function that didn't work, and resubmit by placing the
2848 ## cursor somewhere in the function and
2849 C-c C-f
2850 ## Or you could've selected a region (using the mouse, or keyboard
2851 ## via setting point/mark) and
2852 C-c C-r
2853 ## Or you could step through, line by line, using
2854 C-c C-n
2855 ## Or just send a single line (without moving to the next) using
2856 C-c C-j
2857 ## To fix that error in syntax for the "rchisq" command, get help
2858 ## by
2859 C-c C-v rchisq
2862 4: Data Analysis (S object is real)
2864 M-x S+3
2866 ## Work in the process buffer. When you find an object that needs
2867 ## to be changed (this could be a data frame, or a variable, or a
2868 ## function), dump it to a buffer:
2869 C-c C-d my.cool.function
2871 ## Edit the function as appropriate, and dump back in to the
2872 ## process buffer
2873 C-c C-b
2875 ## Return to the S-PLUS process buffer
2876 C-c C-y
2877 ## Continue working.
2879 ## When you need help, use
2880 C-c C-v rchisq
2881 ## instead of entering: help("rchisq")
2882 </pre>
2884 <p><hr>
2886 Previous: <a rel="previous" accesskey="p" href="#Scenarios-for-use-_0028possibilities_002d_002dbased-on-actual-usage_0029">Scenarios for use (possibilities--based on actual usage)</a>,
2889 </div>
2895 we've stuck you with. Simply edit the "ess-dialect" alist entry in
2897 "S+3". This will ensure that all the inferior process buffer names
2898 are "*S*".
2902 you heavy simulation people). Then uncomment the line in ess-site
2903 (or add after your (require 'ess-site) or (load "ess-site") command
2904 in your .emacs file, the line:
2906 </pre>
2907 <p>)
2910 Splus dumps, a mis-matched " (double-quote) can result in the
2911 wrong font-lock face being used for the remainder of the buffer.
2914 revert the font-lock face back to normal.
2916 <!-- node-name, next, previous, up -->
2918 <p><hr>
2920 Next: <a rel="next" accesskey="n" href="#Editing-R-documentation-files">Editing R documentation files</a>,
2921 Previous: <a rel="previous" accesskey="p" href="#ESS-for-the-S-family">ESS for the S family</a>,
2924 </div>
2928 <p><a name="index-editing-functions-122"></a>ESS provides facilities for editing S objects within your Emacs
2929 session. Most editing is performed on S functions, although in
2930 theory you may edit datasets as well. Edit buffers are always
2931 associated with files, although you may choose to make these files
2932 temporary if you wish. Alternatively, you may make use of a simple yet
2933 powerful mechanism for maintaining backups of text representations of
2934 S functions. Error-checking is performed when S code is loaded
2935 into the ESS process.
2940 <li><a accesskey="3" href="#Error-Checking">Error Checking</a>: Detecting errors in source files
2941 <li><a accesskey="4" href="#Evaluating-code">Evaluating code</a>: Sending code to the ESS process
2943 <li><a accesskey="6" href="#Other-edit-buffer-commands">Other edit buffer commands</a>: Commands for motion, completion and more
2945 <li><a accesskey="8" href="#Source-Directories">Source Directories</a>: Names and locations of dump files
2946 </ul>
2948 <!-- node-name, next, previous, up -->
2950 <p><hr>
2956 </div>
2961 To edit an S object, type
2963 <ul>
2965 <a name="index-ess_002ddump_002dobject_002dinto_002dedit_002dbuffer-124"></a>Edit an S object in its own edit buffer.
2966 </ul>
2969 prompted for an object to edit: you may either type in the name of an
2971 key),
2972 <a name="index-completion_002c-when-prompted-for-object-names-125"></a>or you may enter the name of a new object.
2973 <a name="index-creating-new-objects-126"></a><a name="index-new-objects_002c-creating-127"></a>A buffer will be created containing the text representation of the
2974 requested object or, if you entered the name of a non-existent object at
2976 <a name="index-ess_002dfunction_002dtemplate-128"></a>is non-<code>nil</code>, you will be presented with a template defined by that
2977 variable, which defaults to a skeleton function construct.
2979 <p>You may then edit the function as required. The edit buffer generated
2981 major mode which provides a number of commands to facilitate editing
2982 S source code. Commands are provided to intelligently indent S
2983 code, evaluate portions of S code and to move around S code
2984 constructs.
2986 <p><a name="index-dump-files-129"></a><a name="index-reverting-function-definitions-130"></a>Note: when you dump a file with <kbd>C-c C-d</kbd>, ESS first checks
2987 to see whether there already exists an edit buffer containing that
2988 object and, if so, pops you directly to that buffer. If not, ESS next
2989 checks whether there is a file in the appropriate place with the
2991 You can use this facility to return to an object you were editing in a
2992 previous session (and which possibly was never loaded to the S
2993 session). Finally, if both these tests fail, the ESS process is
2995 <a name="index-dump_0028_0029-131"></a>If you want to force ESS to ask the ESS process for the object's
2996 definition (say, to reformat an unmodified buffer or to revert back to
2997 S's idea of the object's definition) pass a prefix argument to
3000 <!-- node-name, next, previous, up -->
3002 <p><hr>
3008 </div>
3013 — into S is to load them in as source file, using S's
3016 loading source files (even files not created with ESS!) into the ESS
3017 process:
3019 <ul>
3021 <a name="index-ess_002dload_002dfile-132"></a>Loads a file into the ESS process using <code>source()</code>.
3024 <p class="noindent">After typing <kbd>C-c C-l</kbd> you will prompted for the name of the file to
3025 load into S; usually this is the current buffer's file which is the
3027 You will be asked to save the buffer first if it has been modified (this
3029 The file will then be loaded, and if it loads successfully you will be
3030 returned to the ESS process.
3032 <!-- node-name, next, previous, up -->
3034 <p><hr>
3040 </div>
3044 <p><a name="index-errors-134"></a><a name="index-parsing-errors-135"></a>If any errors occur when loading a file with <code>C-c C-l</code>, ESS will
3045 inform you of this fact. In this case, you can jump directly to the
3048 <a name="index-ess_002dparse_002derrors-136"></a>You will be returned to the offending file (loading it into a buffer if
3049 necessary) with point at the line S reported as containing the
3050 error. You may then correct the error, and reload the file. Note that
3051 none of the commands in an S source file will take effect if any
3052 part of the file contains errors.
3054 <p>Sometimes the error is not caused by a syntax error (loading a
3056 simply display a buffer containing S's error message. You can force
3061 <!-- node-name, next, previous, up -->
3063 <p><hr>
3069 </div>
3073 <p>Other commands are also available for evaluating portions of code in the
3074 S process. These commands cause the selected code to be evaluated
3075 directly by the ESS process as if you had typed them in at the
3077 whether both the commands and their output appear in the process buffer
3078 (as if you had typed in the commands yourself) or if the output alone is
3079 echoed. The behavior is controlled by the variable
3081 <a name="index-ess_002deval_002dvisibly_002dp-137"></a>(display output only). Passing a prefix argument (<kbd>C-u</kbd>) to any of
3082 the following commands, however, reverses the meaning of
3084 C-c C-j</kbd> echoes the current line of S (or other) code in the ESS
3085 process buffer, followed by its output. This method of evaluation is an
3087 <a name="index-source_0028_0029-138"></a><a name="index-echoing-commands-when-evaluating-139"></a><a name="index-evaluating-code-with-echoed-commands-140"></a>when you want the input as well as the output to be displayed. (You can
3089 set, except that prompts do not get displayed. ESS puts prompts in the
3090 right places.) The commands for evaluating code are:
3095 <a name="index-ess_002deval_002dline-142"></a>Send the line containing point to the ESS process.
3098 <a name="index-ess_002deval_002dline_002dand_002dgo-143"></a>As above, but returns you to the ESS process buffer as well.
3100 <li><kbd>C-c C-f</kbd> or <kbd>ESC C-x</kbd> (aka <kbd>M-C-x</kbd>) (<code>ess-eval-function</code>) <br>
3101 <a name="index-ess_002deval_002dfunction-144"></a>Send the S function containing point to the ESS process.
3104 <a name="index-ess_002deval_002dfunction_002dand_002dgo-145"></a>As above, but returns you to the ESS process buffer as well.
3107 <a name="index-ess_002deval_002dregion-146"></a>Send the text between point and mark to the ESS process.
3110 <a name="index-ess_002deval_002dregion_002dand_002dgo-147"></a>As above, but returns you to the ESS process buffer as well.
3113 <a name="index-ess_002deval_002dbuffer-148"></a>Send the contents of the edit buffer to the ESS process.
3116 <a name="index-ess_002deval_002dfunction_002dand_002dgo-149"></a>As above, but returns you to the ESS process buffer as well.
3119 <a name="index-ess_002deval_002dline_002dand_002dstep-150"></a><a name="index-stepping-through-code-151"></a><a name="index-debugging-S-functions-152"></a>Sends the current line to the ESS process, echoing it in the process
3120 buffer, and moves point to the next line. Useful when debugging for
3121 stepping through your code.
3122 </ul>
3125 should only be used for evaluating small portions of code for debugging
3126 purposes, or for generating transcripts from source files. When editing
3129 obsolete.
3131 <p>One final command is provided for spot-evaluations of S code:
3133 <ul>
3135 <a name="index-ess_002dexecute_002din_002dtb-153"></a>Prompt for an S expression and evaluate it. Displays result in a
3136 temporary buffer.
3137 </ul>
3141 <p>All the above commands are useful for evaluating small amounts of code
3142 and observing the results in the process buffer. A useful way to work
3143 is to divide the frame into two windows; one containing the source code
3144 and the other containing the process buffer. If you wish to make the
3145 process buffer scroll automatically when the output reaches the bottom
3146 of the window, you will need to set the variable
3149 <!-- node-name, next, previous, up -->
3151 <p><hr>
3153 Next: <a rel="next" accesskey="n" href="#Other-edit-buffer-commands">Other edit buffer commands</a>,
3157 </div>
3161 <p>ESS now provides a sophisticated mechanism for indenting S source
3162 code (thanks to Ken'ichi Shibayama). Compound statements (delimited by
3163 `<samp><span class="samp">{</span></samp>' and `<samp><span class="samp">}</span></samp>') are indented relative to their enclosing block.
3164 In addition, the braces have been electrified to automatically indent to
3165 the correct position when inserted, and optionally insert a newline at
3166 the appropriate place as well. Lines which continue an incomplete
3167 expression are indented relative to the first line of the expression.
3169 and loop constructs are all recognized and indented appropriately. User
3170 variables are provided to control the amount if indentation in each
3171 case, and there are also a number of predefined indentation styles to
3172 choose from.
3174 <p><a name="index-comments-in-S-154"></a>Comments are also handled specially by ESS, using an idea borrowed from
3175 the Emacs-Lisp indentation style. By default,
3177 are aligned to the beginning of the line. Comments beginning with
3178 `<samp><span class="samp">##</span></samp>' are aligned to the current level of indentation for the block
3179 containing the comment. Finally, comments beginning with `<samp><span class="samp">#</span></samp>' are
3180 aligned to a column on the right (the 40th column by default, but this
3182 <a name="index-comment_002dcolumn-155"></a>or just after the expression on the line containing the comment if it
3183 extends beyond the indentation column. You turn off the default
3184 behavior by adding the line
3185 <code>(setq ess-fancy-comments nil)</code> to your <samp><span class="file">.emacs</span></samp> file.
3187 The indentation commands provided by ESS are:
3189 <ul>
3191 Indents the current line as S code. If a prefix argument is given,
3192 all following lines which are part of the same (compound) expression are
3193 indented by the same amount (but relative indents are preserved).
3197 Insert a newline, and indent the next line. (Note that most keyboards
3200 <li><kbd>ESC C-q</kbd> aka <kbd>M-C-q</kbd> aka <kbd>C-M-q</kbd> (<code>ess-indent-exp</code>) <br>
3201 Indents each line in the S (compound) expression which follows point.
3202 Very useful for beautifying your S code.
3205 The braces automatically indent to the correct position when typed.
3208 Indents an existing comment line appropriately, or inserts an
3209 appropriate comment marker.
3212 Set the formatting style in this buffer to be one of the predefined
3213 styles: <code>GNU</code>, <code>BSD</code>, <code>K&R</code>, <code>CLB</code>, and <code>C++</code>.
3215 variables (unless they have been modified in your <samp><span class="file">.emacs</span></samp> file.)
3216 <a name="index-g_t_0040file_007b_002eemacs_007d-file-159"></a>This command causes all of the formatting variables to be buffer-local.
3217 </ul>
3219 <!-- node-name, next, previous, up -->
3221 <p><hr>
3227 </div>
3231 <p>A number of commands are provided to move across function definitions
3232 in the edit buffer:
3233 <ul>
3235 <a name="index-ess_002dbeginning_002dof_002dfunction-160"></a>Moves point to the beginning of the function containing point.
3238 <a name="index-ess_002dend_002dof_002dfunction-161"></a>Moves point to the end of the function containing point.
3241 Places point at the beginning of the S function containing point, and
3242 mark at the end.
3243 </ul>
3244 Don't forget the usual Emacs commands for moving over balanced
3247 <p><a name="index-completion-in-edit-buffer-162"></a>Completion is provided in the edit buffer in a similar fashion to the
3251 however that completion is only provided over globally known S objects
3253 functions or other variables local to the function you are editing.
3255 <p>Finally, two commands are provided for returning to the ESS process buffer:
3257 <ul>
3259 <a name="index-ess_002dswitch_002dto_002dend_002dof_002dESS-163"></a>Returns you to the ESS process buffer, placing point at the end of the
3260 buffer.
3263 <a name="index-ess_002dswitch_002dto_002dESS-164"></a>Also returns to to the ESS process buffer, but leaves point where it was.
3264 </ul>
3266 <p>In addition some commands available in the process buffer are also
3267 available in the edit buffer. You can still read help files with
3270 for more details on these commands.
3272 <!-- node-name, next, previous, up -->
3274 <p><hr>
3277 Previous: <a rel="previous" accesskey="p" href="#Other-edit-buffer-commands">Other edit buffer commands</a>,
3280 </div>
3287 after use, or kept as a backup file or as a means of keeping several
3288 versions of an S function.
3292 — User Option: <b>ess-delete-dump-files</b><var><a name="index-ess_002ddelete_002ddump_002dfiles-166"></a></var><br>
3294 immediately after they are created by the ess-process.
3295 </p></blockquote></div>
3297 <p>Since immediately after S dumps an object's definition to a disk
3298 file the source code on disk corresponds exactly to S's idea of the
3299 object's definition, the disk file isn't needed; deleting it now has the
3301 just wanted to look at the definition of one of the standard S
3302 functions) the source dump file won't be left around when you kill the
3303 buffer. Note that this variable only applies to files generated with
3308 — User Option: <b>ess-keep-dump-files</b><var><a name="index-ess_002dkeep_002ddump_002dfiles-167"></a></var><br>
3309 <blockquote><p>Option controlling what to do with the dump file after an object has
3314 buffer-local.
3315 </p></blockquote></div>
3317 <p>After an object has been successfully (i.e. without error) loaded
3319 exactly (well, almost — see below) to S's record of the object's
3320 definition, and so some people prefer to delete the disk file rather
3321 than unnecessarily use up space. This option allows you to do just
3322 that.
3324 <p><a name="index-comments-168"></a><a name="index-project-work-in-S-169"></a><a name="index-historic-backups-170"></a>If the value of <code>ess-keep-dump-files</code> is <code>t</code>, dump files are
3325 never deleted after they are loaded. Thus you can maintain a complete
3326 text record of the functions you have edited within ESS. Backup files
3327 are kept as usual, and so by using the Emacs numbered backup facility —
3329 record of function definitions. Another possibility is to maintain the
3330 files with a version-control system such as RCS See <a href="emacs.html#Version-Control">Version Control</a>. As long as a dump file exists in the appropriate place for a
3332 file for editing (unless a prefix argument is given) — the ESS
3334 function definition as a means of documentation that does not clutter
3335 the S object itself. Another useful feature is that you may format
3336 the code in any fashion you please without S re-indenting the code
3337 every time you edit it. These features are particularly useful for
3338 project-based work.
3343 to any other file you load (say, a source file of function
3344 definitions), and so can be dangerous to use unless you are careful.
3347 Local Variables section of the file See <a href="emacs.html#File-Variables">Local Variables in Files</a>.
3350 means that ESS will always ask for confirmation before deleting the
3351 file. Since this can get annoying if you always want to delete dump
3355 Emacs session, but query for any other file. Note that in any case you
3356 will only be asked for confirmation once per file, and your answer is
3357 remembered for the rest of the Emacs session.
3359 <p>Note that in all cases, if an error (such as a syntax error) is detected
3361 deleted. This is so that you can edit the file in a new Emacs session
3362 if you happen to quit Emacs before correcting the error.
3364 <p><a name="index-autosaving-171"></a>Dump buffers are always autosaved, regardless of the value of
3367 <!-- node-name, next, previous, up -->
3369 <p><hr>
3374 </div>
3378 <p><a name="index-dump-file-names-172"></a>Every dump file should be given a unique file name, usually the dumped
3379 object name with some additions.
3382 — User Option: <b>ess-dump-filename-template</b><var><a name="index-ess_002ddump_002dfilename_002dtemplate-173"></a></var><br>
3384 object name.
3385 </p></blockquote></div>
3387 <p class="noindent">By default, dump file names are the user name, followed by `<samp><span class="samp">.</span></samp>' and
3388 the object and ending with `<samp><span class="samp">.S</span></samp>'. Thus if user <code>joe</code> dumps the
3389 object <code>myfun</code> the dump file will have name <samp><span class="file">joe.myfun.S</span></samp>.
3390 The username part is included to avoid clashes when dumping into a
3391 publicly-writable directory, such as <samp><span class="file">/tmp</span></samp>; you may wish to remove
3392 this part if you are dumping into a directory owned by you.
3394 <p><a name="index-dump-file-directories-174"></a>You may also specify the directory in which dump files are written:
3397 — User Option: <b>ess-source-directory</b><var><a name="index-ess_002dsource_002ddirectory-175"></a></var><br>
3398 <blockquote><p>Directory name (ending in a slash) where S dump files are to be written.
3399 </p></blockquote></div>
3401 <p>By default, dump files are always written to <samp><span class="file">/tmp</span></samp>, which is fine
3403 files, then you will probably want to keep them somewhere in your home
3404 directory, say <samp><span class="file">~/S-source</span></samp>. This could be achieved by including
3408 </pre>
3409 <p>If you would prefer to keep your dump files in separate directories
3410 depending on the value of some variable, ESS provides a facility for
3412 expression which evaluates to a directory name, you have a great deal of
3413 flexibility in selecting the directory for a particular source file to
3414 appear in. The lambda expression is evaluated with the process buffer
3415 as the current buffer and so you can use the variables local to that
3416 buffer to make your choice. For example, the following expression
3417 causes source files to be saved in the subdirectory <samp><span class="file">Src</span></samp> of the
3418 directory the ESS process was run in.
3421 (lambda ()
3422 (concat ess-directory "Src/")))
3423 </pre>
3424 <p class="noindent"><a name="index-ess_002ddirectory-177"></a>(<code>ess-directory</code> is a buffer-local variable in process buffers
3425 which records the directory the ESS process was run from.) This is
3426 useful if you keep your dump files and you often edit objects with the
3427 same name in different ESS processes. Alternatively, if you often
3428 change your S working directory during an S session, you may
3429 like to keep dump files in some subdirectory of the directory pointed to
3430 by the first element of the current search list. This way you can edit
3431 objects of the same name in different directories during the one S
3432 session:
3435 (lambda ()
3436 (file-name-as-directory
3437 (expand-file-name (concat
3438 (car ess-search-list)
3439 "/.Src")))))
3440 </pre>
3442 If the directory generated by the lambda function does not exist but can
3443 be created, you will be asked whether you wish to create the directory.
3444 If you choose not to, or the directory cannot be created, you will not
3445 be able to edit functions.
3448 <p><hr>
3454 </div>
3459 files. R objects are documented in files written in Rd format, a
3460 simple markup language closely resembling (La)TeX, which can be
3465 <p>Visiting an Rd file as characterized by its extension <samp><span class="file">Rd</span></samp> will
3466 activate Rd Mode, which provides several facilities for making editing R
3467 documentation files more convenient, by helping with indentation,
3468 insertions, even doing some of the typing for you (with Abbrev Mode),
3469 and by showing Rd keywords, strings, etc. in different faces (with
3470 Font Lock Mode).
3472 <p>Note that R also accepts Rd files with extension <samp><span class="file">rd</span></samp>; to activate
3476 </pre>
3479 <p>In Rd mode, the following special Emacs commands can be used in addition
3480 to the standard Emacs commands.
3482 <dl>
3485 <br><dt><kbd>LFD</kbd><dt><kbd>RET</kbd><dd>Reindent the current line, insert a newline and indent the new line
3492 <br><dt><kbd>C-c C-e</kbd><dd>Insert a “skeleton” with Rd markup for at least all mandatory entries
3496 already has all information filled in which can be obtained from the
3497 object).
3499 <br><dt><kbd>C-c C-f</kbd><dd>Insert “font” specifiers for some of the Rd markup commands markup
3500 available for emphasizing or quoting text, including markup for URLs and
3503 currently, not all of the Rd text markup as described in section
3507 <br><dt><kbd>C-c C-j</kbd><dd>Insert a suitably indented `<samp><span class="samp">\item{</span></samp>' on the next line
3510 <br><dt><kbd>C-c C-p</kbd><dd>Preview a plain text version (“help file”, see <a href="#Help">Help</a>) generated
3512 </dl>
3514 <p>In addition, when editing Rd files one can interact with a running R
3515 process in a similar way as when editing R language files. E.g.,
3517 the current line to the R process for evaluation. This interaction is
3518 particularly useful when editing the examples in the Rd file. See
3521 <p>Rd mode also provides access to abbreviations for most of the Rd markup
3523 list all available abbrevs. Note that all Rd abbrevs start with a grave
3524 accent.
3526 <p>Rd mode can be customized via the following variables.
3528 <dl>
3530 <br><dt><code>Rd-indent-level</code><dd>The indentation of Rd code with respect to containing blocks. Default
3531 is 2.
3532 <br><dt><code>Rd-to-help-command</code><dd>The shell command used for converting Rd source to help text. Default
3534 </dl>
3536 <p>To automatically turn on the abbrev and font-lock features of Rd mode,
3537 add the following lines to one of your Emacs startup files:
3540 (lambda ()
3541 (abbrev-mode 1)
3542 (font-lock-mode 1)))
3543 </pre>
3544 <!-- node-name, next, previous, up -->
3546 <p><hr>
3549 Previous: <a rel="previous" accesskey="p" href="#Editing-R-documentation-files">Editing R documentation files</a>,
3552 </div>
3557 ESS provides an easy-to-use facility for reading S help files from
3558 within Emacs. From within the ESS process buffer or any ESS edit
3560 <a name="index-ess_002ddisplay_002dhelp_002don_002dobject-182"></a>will prompt you for the name of an object for which you would like
3561 documentation. Completion is provided over all objects which have help
3562 files.
3564 <p>If the requested object has documentation, you will be popped into a
3566 This buffer is placed in a special `S Help' mode which disables the
3567 usual editing commands but which provides a number of keys for paging
3568 through the help file:
3570 <ul>
3571 Help commands:
3574 <a name="index-ess_002ddescribe_002dhelp_002dmode-183"></a>Pops up a help buffer with a list of the commands available in S help
3575 mode.
3578 <a name="index-ess_002ddisplay_002dhelp_002don_002dobject-184"></a>Pop up a help buffer for a different object
3580 <p>Paging commands:
3582 <p><a name="index-paging-commands-in-help-buffers-185"></a><li><kbd>b</kbd> or <kbd>DEL</kbd> (<code>scroll-down</code>) <br>
3583 Move one page backwards through the help file.
3586 Move one page forwards through the help file.
3588 <li><kbd>></kbd> (<code>beginning-of-buffer</code>) and <kbd><</kbd> (<code>end-of-buffer</code>)
3589 <br>
3590 Move to the beginning and end of the help file, respectively.
3592 <p>Section-based motion commands:
3596 <a name="index-ess_002dskip_002dto_002dnext_002dsection-186"></a><a name="index-ess_002dskip_002dto_002dprevious_002dsection-187"></a>section header in the help file, respectively. A section header
3597 consists of a number of capitalized words, followed by a colon.
3600 will jump to a particular section in the help file:
3602 <dl>
3635 <br><dt>`<samp><span class="samp">?</span></samp>'<dd>Pops up a help buffer with a list of the defined section motion keys.
3636 </dl>
3638 <p>Miscellaneous:
3641 <a name="index-ess_002deval_002dline_002dand_002dstep-189"></a>Evaluates the current line in the ESS process, and moves to the next
3642 line. Useful for running examples in help files.
3645 <a name="index-ess_002deval_002dregion-190"></a>Send the contents of the current region to the ESS process. Useful
3646 for running examples in help files.
3651 <p>Quit commands:
3654 <a name="index-ess_002dswitch_002dto_002dend_002dof_002dESS-191"></a>Returns to the ESS process buffer in another window, leaving the
3655 help window visible.
3658 Kills the help buffer.
3661 Return to the ESS process, killing this help buffer.
3662 </ul>
3664 <p>In addition, all of the ESS commands available in the edit buffers are
3666 usual (non-editing) Emacs commands are available, and for convenience
3669 <p>If a help buffer already exists for an object for which help is
3670 requested, that buffer is popped to immediately; the ESS process is
3671 not consulted at all. If the contents of the help file have changed,
3672 you either need to kill the help buffer first, or pass a prefix argument
3675 <p>Help buffers are marked as temporary buffers in ESS, and are deleted
3678 <p>Help buffers normally appear in another window within the current
3679 frame. If you wish help buffers to appear in their own frame (either
3680 one per help buffer, or one for all help buffers), you can customize the
3683 <p><a name="index-ess_002dquit-192"></a><a name="index-ess_002dcleanup-193"></a><a name="index-temporary-buffers-194"></a>
3684 <!-- node-name, next, previous, up -->
3686 <p><hr>
3692 </div>
3697 <li><a accesskey="1" href="#ESS_0028SAS_0029_002d_002dDesign-philosophy">ESS(SAS)--Design philosophy</a>
3698 <li><a accesskey="2" href="#ESS_0028SAS_0029_002d_002dEditing-files">ESS(SAS)--Editing files</a>
3700 <li><a accesskey="4" href="#ESS_0028SAS_0029_002d_002dBatch-SAS-processes">ESS(SAS)--Batch SAS processes</a>
3701 <li><a accesskey="5" href="#ESS_0028SAS_0029_002d_002dFunction-keys-for-batch-processing">ESS(SAS)--Function keys for batch processing</a>
3702 <li><a accesskey="6" href="#iESS_0028SAS_0029_002d_002dInteractive-SAS-processes">iESS(SAS)--Interactive SAS processes</a>
3703 <li><a accesskey="7" href="#iESS_0028SAS_0029_002d_002dCommon-problems">iESS(SAS)--Common problems</a>
3706 </ul>
3708 <p><acronym>ESS[SAS]</acronym> was designed for use with <acronym>SAS</acronym><!-- /@w -->. It is descended from emacs
3709 macros developed by John Sall for editing <acronym>SAS</acronym><!-- /@w --> programs and <code>SAS-mode</code> by
3710 Tom Cook. Those editing features and new advanced features are part of
3711 <acronym>ESS[SAS]</acronym>. The user interface of <acronym>ESS[SAS]</acronym> has similarities with <acronym>ESS[S]</acronym>
3714 <!-- node-name, next, previous, up -->
3716 <p><hr>
3719 Next: <a rel="next" accesskey="n" href="#ESS_0028SAS_0029_002d_002dEditing-files">ESS(SAS)--Editing files</a>,
3723 </div>
3727 <p><acronym>ESS[SAS]</acronym> was designed to aid the user in writing and maintaining <acronym>SAS</acronym><!-- /@w -->
3728 programs, such as <samp><var>foo</var><span class="file">.sas</span></samp>. Both interactive and batch
3733 <li>The emacs text editor provides a powerful and flexible development
3734 environment for programming languages. These features are a boon to all
3735 programmers and, with the help of <acronym>ESS[SAS]</acronym>, to <acronym>SAS</acronym><!-- /@w --> users as well.
3736 <li>Although a departure from <acronym>SAS</acronym><!-- /@w --> Display Manager, <acronym>ESS[SAS]</acronym> provides
3738 Also, inconvenient <acronym>SAS</acronym><!-- /@w --> Display Manager features, like remote submission
3739 and syntax highlighting, are provided transparently; appealing to
3741 </ol>
3743 <!-- node-name, next, previous, up -->
3745 <p><hr>
3748 Next: <a rel="next" accesskey="n" href="#ESS_0028SAS_0029_002d_002dTAB-key">ESS(SAS)--TAB key</a>,
3749 Previous: <a rel="previous" accesskey="p" href="#ESS_0028SAS_0029_002d_002dDesign-philosophy">ESS(SAS)--Design philosophy</a>,
3752 </div>
3756 <p><acronym>ESS[SAS]</acronym> is the mode for editing <acronym>SAS</acronym><!-- /@w --> language files. This mode handles:
3758 <ul>
3760 <li>color and font choices based on syntax.
3761 <li>ability to save and submit the file you are working on as a batch
3762 <acronym>SAS</acronym><!-- /@w --> process with a single keypress and to continue editing while it is runs
3763 in the background.
3764 <li>capability of killing the batch <acronym>SAS</acronym><!-- /@w --> process through the <samp><span class="file">*shell*</span></samp> buffer or
3766 <li>single keypress navigation of <samp><span class="file">.sas</span></samp>, <samp><span class="file">.log</span></samp> and <samp><span class="file">.lst</span></samp> files
3767 (<samp><span class="file">.log</span></samp> and <samp><span class="file">.lst</span></samp> files are refreshed with each keypress).
3768 <li>ability to send the contents of an entire buffer, a highlighted region,
3770 <li>ability to switch between processes which would be the target of the
3771 buffer (for the above).
3772 </ul>
3774 <p><acronym>ESS[SAS]</acronym> is automatically turned on when editing a file with a <samp><span class="file">.sas</span></samp>
3776 keys can be enabled to use the same function keys that
3777 the <acronym>SAS</acronym><!-- /@w --> Display Manager does. The interactive capabilities of <acronym>ESS</acronym> require you
3778 to start an inferior <acronym>SAS</acronym><!-- /@w --> process with <kbd>M-x SAS</kbd><!-- /@w -->
3779 (See <a href="#iESS_0028SAS_0029_002d_002dInteractive-SAS-processes">iESS(SAS)–Interactive SAS processes</a>.)
3781 <p>At this writing, the indenting and syntax highlighting are generally
3783 first line is highlighted; for <samp><span class="file">.log</span></samp> files, only the first line of a
3784 <code>NOTE:</code>, <code>WARNING:</code> or <code>ERROR:</code> message is highlighted; unmatched
3788 <!-- node-name, next, previous, up -->
3790 <p><hr>
3793 Next: <a rel="next" accesskey="n" href="#ESS_0028SAS_0029_002d_002dBatch-SAS-processes">ESS(SAS)--Batch SAS processes</a>,
3794 Previous: <a rel="previous" accesskey="p" href="#ESS_0028SAS_0029_002d_002dEditing-files">ESS(SAS)--Editing files</a>,
3797 </div>
3802 function is used to syntactically indent <acronym>SAS</acronym><!-- /@w --> code so <code>PROC</code> and <code>RUN</code> are in
3803 the left margin, other statements are indented <code>sas-indent-width</code> spaces from the margin,
3804 continuation lines are indented <code>sas-indent-width</code> spaces in from the beginning column of
3805 that statement. This is the type of functionality that emacs provides
3806 in most programming language modes. This functionality is equivalent to
3809 </pre>
3811 as it does in <acronym>SAS</acronym><!-- /@w --> Display Manager, i.e. move the cursor to the next stop.
3812 The alternate behavior also provides a "TAB" backwards, <kbd>C-<TAB></kbd><!-- /@w -->, that
3813 moves the cursor to the stop to the left and deletes any characters
3814 between them. This functionality is obtained by uncommenting the
3817 </pre>
3818 <p>Under the alternate behavior, <TAB> is bound to <kbd>M-x tab-to-tab-stop</kbd><!-- /@w -->
3821 <!-- node-name, next, previous, up -->
3823 <p><hr>
3826 Next: <a rel="next" accesskey="n" href="#ESS_0028SAS_0029_002d_002dFunction-keys-for-batch-processing">ESS(SAS)--Function keys for batch processing</a>,
3827 Previous: <a rel="previous" accesskey="p" href="#ESS_0028SAS_0029_002d_002dTAB-key">ESS(SAS)--TAB key</a>,
3830 </div>
3834 <p>Submission of a <acronym>SAS</acronym><!-- /@w --> batch job is dependent on your environment.
3838 a <acronym>UNIX</acronym>-imitating shell; otherwise <code>'ms-dos</code> for an <acronym>MS-DOS</acronym>
3841 if the <acronym>SAS</acronym><!-- /@w --> batch job needs to run on a remote machine rather than your
3842 local machine. This works transparently if you are editing the remote file
3843 via ange-ftp/EFS or tramp. Note that
3846 and it is assumed that no password is necessary, i.e. you are using
3848 Local Variables below if you need to change the default).
3850 <p>However, if you are editing the file locally and transferring it back and
3851 forth with Kermit, you need some additional steps. First, start Kermit
3852 locally before remotely logging in. Open a local copy of the file with the
3855 the contents of the remote file into your local copy. If you transfer
3856 files with Kermit manually in a <samp><span class="file">*shell*</span></samp> buffer, then note that the
3857 Kermit escape sequence is <kbd>C-q C- c</kbd><!-- /@w --> rather than <kbd>C- c</kbd><!-- /@w --> which
3858 it would be in an ordinary terminal application, i.e. not in an emacs
3859 buffer. Lastly, note that the remote Kermit command is specified by
3868 buffer-local. Conveniently, it can be set at the end of the program:
3870 Local variables:
3871 ess-sas-submit-command: "sas8"
3872 End:
3873 </pre>
3876 (the last of which is also buffer-local).
3877 Here are some examples for your <samp><span class="file">~/.emacs</span></samp> or <samp><span class="file">~/.xemacs/init.el</span></samp>
3880 (setq ess-sas-submit-pre-command "nohup")
3881 ;'sh default
3882 (setq ess-sas-submit-post-command "-rsasuser &")
3883 ;'sh example
3884 (setq-default ess-sas-submit-command "/usr/local/sas/sas")
3885 ;'ms-dos default
3886 (setq ess-sas-submit-pre-command "start")
3887 ;'ms-dos default
3888 (setq ess-sas-submit-post-command "-rsasuser -icon")
3889 ;Windows example
3890 (setq-default ess-sas-submit-command "c:/progra~1/sas/sas.exe")
3891 ;Windows example
3892 (setq-default ess-sas-submit-command "c:\\progra~1\\sas\\sas.exe")
3893 </pre>
3894 <p>There is a built-in delay before a batch <acronym>SAS</acronym><!-- /@w --> job is submitted when using
3896 since the shell might not be ready to receive a command. This delay is
3897 currently set high enough so as not to be a problem. But, there may be
3898 cases when it needs to be set higher, or could be set much lower to
3899 speed things up. You can over-ride the default in your <samp><span class="file">~/.emacs</span></samp> or <samp><span class="file">~/.xemacs/init.el</span></samp> file by:
3901 </pre>
3906 <samp><var>foo</var><span class="file">.sas</span></samp> will be in <acronym>ESS[SAS]</acronym> mode. Edit as appropriate, then save and
3909 </pre>
3910 <p>The job runs in the <samp><span class="file">*shell*</span></samp> buffer while you continue to edit
3911 <samp><var>foo</var><span class="file">.sas</span></samp>. If <code>ess-sas-submit-method</code> is <code>'sh</code>, then the
3912 message buffer will display the shell notification when the
3916 </pre>
3917 <p>Terminating a <acronym>SAS</acronym><!-- /@w --> batch in the <samp><span class="file">*shell*</span></samp> buffer.
3919 </pre>
3920 <p>You may want to visit the <samp><span class="file">.log</span></samp> (whether the job is still running
3921 or it is finished) and check for error messages. The <samp><span class="file">.log</span></samp> will be
3922 refreshed and you will be placed in it's buffer. You will be
3923 taken to the first error message, if any.
3925 </pre>
3926 <p>Goto the next error message, if any.
3928 </pre>
3929 <p>Now, `<samp><span class="samp">refresh</span></samp>' the <samp><span class="file">.lst</span></samp> and go to it's buffer.
3931 </pre>
3932 <p>If you wish to make changes, go to the <samp><span class="file">.sas</span></samp> file with.
3934 </pre>
3935 <p>Make your editing changes and submit again.
3937 </pre>
3938 <!-- node-name, next, previous, up -->
3940 <p><hr>
3943 Next: <a rel="next" accesskey="n" href="#iESS_0028SAS_0029_002d_002dInteractive-SAS-processes">iESS(SAS)--Interactive SAS processes</a>,
3944 Previous: <a rel="previous" accesskey="p" href="#ESS_0028SAS_0029_002d_002dBatch-SAS-processes">ESS(SAS)--Batch SAS processes</a>,
3947 </div>
3952 is unavoidably complex, but the usage of function keys is simple.
3953 There are five distinct options:
3956 commands. This is in accordance with the GNU Elisp Coding Standards
3958 available to the user.
3962 the option of binding elisp commands to these keys. Users who are
3963 familiar with <acronym>SAS</acronym><!-- /@w --> will, most likely, want to duplicate the function key
3964 capabilities of the <acronym>SAS</acronym><!-- /@w --> Display Manager. There are four options (noted
3965 in parentheses).
3968 <li><acronym>SAS</acronym><!-- /@w --> Display Manager has different function key definitions for
3972 are associated with <acronym>ESS[SAS]</acronym> as specified in your <code>auto-mode-alist</code>.
3973 </ol>
3975 <p>The distinction between local and global is subtle. If you want the
3976 <acronym>ESS[SAS]</acronym> definitions to work when you are in the <samp><span class="file">*shell*</span></samp> buffer or when
3978 you will most likely want to use the global definitions. If you want
3979 your function keys to understand <acronym>SAS</acronym><!-- /@w --> batch commands when you are editing
3980 <acronym>SAS</acronym><!-- /@w --> files, and to behave normally when editing other files, then you
3981 will choose the local definitions. The option can be chosen by the
3986 following lines in your <samp><span class="file">ess-site.el</span></samp>. <acronym>ESS[SAS]</acronym> function keys are
3990 ;;3; (setq ess-sas-local-pc-keys t)
3991 ;;4; (setq ess-sas-global-unix-keys t)
3992 ;;5; (setq ess-sas-global-pc-keys t)
3993 </pre>
3994 <p>The names <code>-unix-</code> and <code>-pc-</code> have nothing to do with the operating system
3995 that you are running. Rather, they mimic the definitions that the <acronym>SAS</acronym><!-- /@w -->
3996 Display Manager uses by default on those platforms.
3998 <li>If your site installation has configured the keys contrary to your
3999 liking, then you must call the appropriate function.
4001 (ess-sas-global-pc-keys)
4002 </pre>
4003 </ol>
4005 <p>Finally, we get to what the function keys actually do. You may recognize
4006 some of the nicknames as <acronym>SAS</acronym><!-- /@w --> Display Manager commands (they are in all
4007 capitals).
4009 <p><table summary=""><tr align="left"><td valign="top"><acronym>UNIX</acronym> </td><td valign="top"><acronym>PC</acronym> </td><td valign="top">Nickname
4010 <br></td></tr><tr align="left"><td valign="top"><F2> </td><td valign="top"><F2> </td><td valign="top">`<samp><span class="samp">refresh</span></samp>'
4012 revert the current buffer with the file of the same
4013 name if the file is newer than the buffer
4014 <br></td></tr><tr align="left"><td valign="top"><F3> </td><td valign="top"><F8> </td><td valign="top"><code>SUBMIT</code>
4016 save the current <samp><span class="file">.sas</span></samp> file (which is either the <samp><span class="file">.sas</span></samp>
4018 with the <samp><span class="file">.lst</span></samp> or <samp><span class="file">.log</span></samp> file in the current buffer)
4020 <br></td></tr><tr align="left"><td valign="top"><F4> </td><td valign="top"><F5> </td><td valign="top"><code>PROGRAM</code>
4023 <br></td></tr><tr align="left"><td valign="top"><F5> </td><td valign="top"><F6> </td><td valign="top"><code>LOG</code>
4025 switch buffer to <samp><span class="file">.log</span></samp> file, `<samp><span class="samp">refresh</span></samp>' and goto next
4026 error message, if any
4027 <br></td></tr><tr align="left"><td valign="top"><F6> </td><td valign="top"><F7> </td><td valign="top"><code>OUTPUT</code>
4029 switch buffer to <samp><span class="file">.lst</span></samp> file and `<samp><span class="samp">refresh</span></samp>'
4030 <br></td></tr><tr align="left"><td valign="top"><F7> </td><td valign="top"><F4> </td><td valign="top">`<samp><span class="samp">filetype-1</span></samp>'
4032 switch buffer to `<samp><span class="samp">filetype-1</span></samp>' (defaults to <samp><span class="file">.txt</span></samp>) file
4034 <br></td></tr><tr align="left"><td valign="top"><F8> </td><td valign="top"><F3> </td><td valign="top">`<samp><span class="samp">shell</span></samp>'
4037 <br></td></tr><tr align="left"><td valign="top"><F9> </td><td valign="top"><F9> </td><td valign="top"><code>VIEWTABLE</code>
4040 dataset near point
4041 <br></td></tr><tr align="left"><td valign="top"><F10> </td><td valign="top"><F10> </td><td valign="top">toggle-log
4043 toggle <acronym>ESS[SAS]</acronym> for <samp><span class="file">.log</span></samp> files; useful for certain
4044 debugging situations
4045 <br></td></tr><tr align="left"><td valign="top"><F11> </td><td valign="top"><F11> </td><td valign="top">`<samp><span class="samp">filetype-2</span></samp>'
4047 switch buffer to `<samp><span class="samp">filetype-2</span></samp>' (defaults to <samp><span class="file">.dat</span></samp>) file
4049 <br></td></tr><tr align="left"><td valign="top"><F12> </td><td valign="top"><F12> </td><td valign="top">viewgraph
4052 or with an external viewer
4053 <br></td></tr><tr align="left"><td valign="top"><kbd>C-<F1></kbd> </td><td valign="top"><kbd>C-<F1></kbd> </td><td valign="top">rtf-portrait
4057 <br></td></tr><tr align="left"><td valign="top"><kbd>C-<F2></kbd> </td><td valign="top"><kbd>C-<F2></kbd> </td><td valign="top">rtf-landscape
4061 <br></td></tr><tr align="left"><td valign="top"><kbd>C-<F3></kbd> </td><td valign="top"><kbd>C-<F8></kbd> </td><td valign="top">submit-region
4064 <br></td></tr><tr align="left"><td valign="top"><kbd>C-<F5></kbd> </td><td valign="top"><kbd>C-<F6></kbd> </td><td valign="top">append-to-log
4066 append <samp><span class="file">ess-temp.log</span></samp> to the current <samp><span class="file">.log</span></samp> file
4067 <br></td></tr><tr align="left"><td valign="top"><kbd>C-<F6></kbd> </td><td valign="top"><kbd>C-<F7></kbd> </td><td valign="top">append-to-output
4069 append <samp><span class="file">ess-temp.lst</span></samp> to the current <samp><span class="file">.lst</span></samp> file
4070 <br></td></tr><tr align="left"><td valign="top"><kbd>C-<F9></kbd> </td><td valign="top"><kbd>C-<F9></kbd> </td><td valign="top"><code>INSIGHT</code>
4072 open an interactive <code>PROC INSIGHT</code> session on the <acronym>SAS</acronym><!-- /@w -->
4073 dataset near point
4074 <br></td></tr><tr align="left"><td valign="top"><kbd>C-<F10></kbd> </td><td valign="top"><kbd>C-<F10></kbd> </td><td valign="top">toggle-listing
4076 toggle <acronym>ESS[SAS]</acronym> for <samp><span class="file">.lst</span></samp> files; useful for toggling
4077 read-only
4078 <br></td></tr></table>
4080 <p><code>SUBMIT</code>, <code>PROGRAM</code>, <code>LOG</code> and <code>OUTPUT</code> need no further
4081 explanation since they mimic the <acronym>SAS</acronym><!-- /@w --> Display Manager commands and
4082 related function key definitions. However, six other keys have been
4083 provided for convenience and are described below.
4085 <p>`<samp><span class="samp">shell</span></samp>' switches you to the <samp><span class="file">*shell*</span></samp> buffer where you can
4086 interact with your operating system. This is especially helpful if you
4087 would like to kill a <acronym>SAS</acronym><!-- /@w --> batch job. You can specify a different buffer
4088 name to associate with a <acronym>SAS</acronym><!-- /@w --> batch job (besides <samp><span class="file">*shell*</span></samp>) with the
4090 multiple buffers running <acronym>SAS</acronym><!-- /@w --> batch jobs on multiple local/remote
4091 computers that may rely on different methods specified by the buffer-local
4094 <p><F2> performs the `<samp><span class="samp">refresh</span></samp>' operation on the current buffer.
4095 `<samp><span class="samp">refresh</span></samp>' compares the buffer's last modified date/time with the
4096 file's last modified date/time and replaces the buffer with the file if the
4097 file is newer. This is the same operation that is automatically performed
4098 when <code>LOG</code>, <code>OUTPUT</code>, `<samp><span class="samp">filetype-1</span></samp>' or <F11> are pressed.
4100 <p>`<samp><span class="samp">filetype-1</span></samp>' switches you to a file with the same file name as your <samp><span class="file">.sas</span></samp>
4101 file, but with a different extension (<samp><span class="file">.txt</span></samp> by default) and performs
4102 `<samp><span class="samp">refresh</span></samp>'. You can over-ride the default extension; for example in your
4103 <samp><span class="file">~/.emacs</span></samp> or <samp><span class="file">~/.xemacs/init.el</span></samp> file:
4105 </pre>
4106 <p><F9> will prompt you for the name of a permanent <acronym>SAS</acronym><!-- /@w --> dataset near
4108 <acronym>SAS</acronym><!-- /@w --> batch command-line with <code>ess-sas-data-view-submit-options</code>.
4109 For controlling the <acronym>SAS</acronym><!-- /@w --> batch commands, you have the global variables
4113 <acronym>SAS</acronym><!-- /@w --> <code>LIBNAME</code> defined in <samp><span class="file">~/autoexec.sas</span></samp>, then the defaults
4114 for these variables should be sufficient.
4117 <acronym>SAS</acronym><!-- /@w --> dataset near point to be opened for viewing by <code>PROC INSIGHT</code>.
4119 <code>ess-sas-data-view-submit-options</code>. For controlling the <acronym>SAS</acronym><!-- /@w --> batch
4124 <p><F10> toggles <acronym>ESS[SAS]</acronym> mode for <samp><span class="file">.log</span></samp> files which is off by default
4126 highlighting can be helpful in certain debugging situations, but large
4129 <p><F11> is the same as `<samp><span class="samp">filetype-1</span></samp>' except it is <samp><span class="file">.dat</span></samp> by default.
4131 <p><F12> will prompt you for the name of a <code>GSASFILE</code> near the point in <samp><span class="file">.log</span></samp> to
4132 be opened for viewing either with emacs or with an external viewer.
4133 Depending on your version of emacs and the operating system you are
4134 using, emacs may support <samp><span class="file">.gif</span></samp> and <samp><span class="file">.jpg</span></samp> files internally. You may need
4135 to change the following variables for your own situation.
4137 file types defined via file name extensions.
4140 exceptions to the default; i.e. file types and their associated
4141 viewers which will be used rather than the default viewer.
4143 "[pP][dD][fF]\\|[gG][iI][fF]\\|[jJ][pP][eE]?[gG]\\|"
4144 "[tT][iI][fF][fF]?\\)")) ;; default
4145 (setq ess-sas-graph-view-viewer-default "kodakimg") ;; Windows default
4146 (setq ess-sas-graph-view-viewer-default "sdtimage") ;; Solaris default
4147 (setq ess-sas-graph-view-viewer-alist
4149 </pre>
4150 <p><kbd>C-<F2></kbd><!-- /@w --> produces US landscape by default, however, it can produce A4
4153 (define-key sas-mode-local-map [(control f2)] 'ess-sas-rtf-a4-landscape)
4154 </pre>
4155 <!-- node-name, next, previous, up -->
4157 <p><hr>
4160 Next: <a rel="next" accesskey="n" href="#iESS_0028SAS_0029_002d_002dCommon-problems">iESS(SAS)--Common problems</a>,
4161 Previous: <a rel="previous" accesskey="p" href="#ESS_0028SAS_0029_002d_002dFunction-keys-for-batch-processing">ESS(SAS)--Function keys for batch processing</a>,
4164 </div>
4168 <p>Inferior <acronym>ESS</acronym> (i<acronym>ESS</acronym><!-- /@w -->) is the method for interfacing with interactive
4169 statistical processes (programs). i<acronym>ESS[SAS]</acronym><!-- /@w --> is what is needed for
4170 interactive <acronym>SAS</acronym><!-- /@w --> programming. i<acronym>ESS[SAS]</acronym><!-- /@w --> works best
4176 required to make the redirection of stdio work
4178 keeps output lines from folding on standard terminals
4180 prevents error messages from printing 3 times
4182 permits recovery after syntax errors
4183 </pre>
4186 </pre>
4187 <p>The <samp><span class="file">*SAS:1.log*</span></samp> buffer in <code>ESStr</code> mode corresponds to the file
4188 <samp><var>foo</var><span class="file">.log</span></samp> in <acronym>SAS</acronym><!-- /@w --> batch usage and to the `<samp><span class="samp">SAS: LOG</span></samp>' window in the
4189 <acronym>SAS</acronym><!-- /@w --> Display Manager. All commands submitted to <acronym>SAS</acronym><!-- /@w -->, informative
4190 messages, warnings, and errors appear here.
4192 <p>The <samp><span class="file">*SAS:1.lst*</span></samp> buffer in <code>ESSlst</code> mode corresponds to the file
4193 <samp><var>foo</var><span class="file">.lst</span></samp> in <acronym>SAS</acronym><!-- /@w --> batch usage and to the `<samp><span class="samp">SAS: OUTPUT</span></samp>' window in the
4196 <p>The <samp><span class="file">*SAS:1*</span></samp> buffer exists solely as a communications buffer.
4197 The user should never use this buffer directly.
4198 Files are edited in the <samp><var>foo</var><span class="file">.sas</span></samp> buffer. The <kbd>C-c C-r</kbd><!-- /@w --> key in
4200 `<samp><span class="samp">SAS: PROGRAM EDITOR</span></samp>' window followed by <code>SUBMIT</code>.
4202 <p>For example, open the file you want to work with.
4204 </pre>
4205 <p><samp><var>foo</var><span class="file">.sas</span></samp> will be in <acronym>ESS[SAS]</acronym> mode. Edit as appropriate, and then start
4206 up <acronym>SAS</acronym><!-- /@w --> with the cursor in the <samp><var>foo</var><span class="file">.sas</span></samp> buffer.
4208 </pre>
4209 <p>Four buffers will appear on screen:
4210 <p><table summary=""><tr align="left"><td valign="top">Buffer </td><td valign="top">Mode </td><td valign="top">Description
4211 <br></td></tr><tr align="left"><td valign="top"><samp><var>foo</var><span class="file">.sas</span></samp> </td><td valign="top"><code><acronym>ESS[SAS]</acronym></code> </td><td valign="top">your source file
4212 <br></td></tr><tr align="left"><td valign="top"><samp><span class="file">*SAS:1*</span></samp> </td><td valign="top"><code>i<acronym>ESS[SAS:1]</acronym><!-- /@w --></code> </td><td valign="top">i<acronym>ESS</acronym><!-- /@w --> communication buffer
4213 <br></td></tr><tr align="left"><td valign="top"><samp><span class="file">*SAS:1.log*</span></samp> </td><td valign="top"><code>Shell ESStr []</code> </td><td valign="top"><acronym>SAS</acronym><!-- /@w --> log information
4214 <br></td></tr><tr align="left"><td valign="top"><samp><span class="file">*SAS:1.lst*</span></samp> </td><td valign="top"><code>Shell ESSlst []</code> </td><td valign="top"><acronym>SAS</acronym><!-- /@w --> listing information
4215 <br></td></tr></table>
4216 If you would prefer each of the four buffers to appear in its
4217 own individual frame, you can arrange for that. Place the
4218 cursor in the buffer displaying <samp><var>foo</var><span class="file">.sas</span></samp>. Enter the
4220 <samp><var>foo</var><span class="file">.sas</span></samp>. If not, put it there and <kbd>C-x b </kbd><var>foo</var><kbd>.sas</kbd><!-- /@w -->.
4223 (regions are most useful: a highlighted region will normally
4227 <p>Information appears in the log buffer, analysis results in the
4228 listing buffer. In case of errors, make the corrections in the
4229 <samp><var>foo</var><span class="file">.sas</span></samp> buffer and resubmit with another <kbd>C-c C-r</kbd><!-- /@w -->.
4231 <p>At the end of the session you may save the log and listing
4233 for a file name. Typically, the names <samp><var>foo</var><span class="file">.log</span></samp> and <samp><var>foo</var><span class="file">.lst</span></samp>
4234 will be used. You will almost certainly want to edit the saved
4235 files before including them in a report. The files are
4236 read-only by default. You can make them writable by the emacs
4239 <p>At the end of the session, the input file <samp><var>foo</var><span class="file">.sas</span></samp> will
4240 typically have been revised. You can save it. It can be used
4244 <p>The <samp><span class="file">*SAS:1*</span></samp> buffer is strictly for <acronym>ESS</acronym> use. The user should
4245 never need to read it or write to it. Refer to the <samp><span class="file">.lst</span></samp> and
4248 <p>Troubleshooting: See <a href="#iESS_0028SAS_0029_002d_002dCommon-problems">iESS(SAS)–Common problems</a>.
4250 <!-- node-name, next, previous, up -->
4252 <p><hr>
4255 Next: <a rel="next" accesskey="n" href="#ESS_0028SAS_0029_002d_002dGraphics">ESS(SAS)--Graphics</a>,
4256 Previous: <a rel="previous" accesskey="p" href="#iESS_0028SAS_0029_002d_002dInteractive-SAS-processes">iESS(SAS)--Interactive SAS processes</a>,
4259 </div>
4264 <li>i<acronym>ESS[SAS]</acronym><!-- /@w --> does not work on Windows. In order to run <acronym>SAS</acronym><!-- /@w --> inside
4265 an emacs buffer, it is necessary to start <acronym>SAS</acronym><!-- /@w --> with the <code>-stdio</code> option.
4268 <ul>
4270 <li><samp><span class="file">ess-sas-sh-command</span></samp> (from the <acronym>ESS</acronym> <samp><span class="file">etc</span></samp> directory) needs to be
4272 type <kbd>M-:</kbd>, then at the minibuffer prompt `<samp><span class="samp">Eval:</span></samp>'<!-- /@w -->,
4274 <!-- (solution: @code{chmod ugo+rx ess-sas-sh-command}). -->
4276 <kbd>M-:</kbd> and at the minibuffer prompt `<samp><span class="samp">Eval:</span></samp>', type
4278 </ul>
4279 <li><kbd>M-x SAS</kbd><!-- /@w --> starts <acronym>SAS</acronym><!-- /@w --> Display<!-- /@w --> Manager. Probably, the command <code>sas</code>
4280 on your system calls a shell script. In that case you will need to locate
4284 </pre>
4286 directory, with for example
4288 ln -s /usr/local/sas9/sas sas
4289 </pre>
4290 </ol>
4293 shell script appears.
4295 <!-- Specify the path to the real -->
4296 <!-- @code{sas} executable in @file{ess-sas-sh-command}, i.e.: -->
4297 <!-- @example -->
4298 <!-- /usr/local/sas9/sas $@@ </dev/tty 1>$stdout 2>$stderr -->
4299 <!-- @end example -->
4300 <!-- To find the @code{sas} executable, you can execute the @UNIX{} command: -->
4301 <!-- @example -->
4302 <!-- find / -name sas -print -->
4303 <!-- @end example -->
4304 <!-- @end enumerate -->
4305 <!-- node-name, next, previous, up -->
4307 <p><hr>
4310 Next: <a rel="next" accesskey="n" href="#ESS_0028SAS_0029_002d_002dWindows">ESS(SAS)--Windows</a>,
4311 Previous: <a rel="previous" accesskey="p" href="#iESS_0028SAS_0029_002d_002dCommon-problems">iESS(SAS)--Common problems</a>,
4314 </div>
4318 <p>Output from a <acronym>SAS/GRAPH</acronym><!-- /@w --> <code>PROC</code> can be displayed in a <acronym>SAS/GRAPH</acronym><!-- /@w -->
4319 window for <acronym>SAS</acronym><!-- /@w --> batch on Windows or for both <acronym>SAS</acronym><!-- /@w --> batch and interactive
4322 <samp><var>foo</var><span class="file">.sas</span></samp> or in <samp><span class="file">~/autoexec.sas</span></samp>):
4324 goptions device=ps gsfname=gsasfile gsfmode=append;
4325 </pre>
4327 wish to control the vertical spacing to allow the entire plot
4328 to be visible on screen, for example:
4330 plot a*b / vpos=25;
4331 run;
4332 </pre>
4333 <!-- node-name, next, previous, up -->
4335 <p><hr>
4338 Previous: <a rel="previous" accesskey="p" href="#ESS_0028SAS_0029_002d_002dGraphics">ESS(SAS)--Graphics</a>,
4341 </div>
4345 <ul>
4346 <li>i<acronym>ESS[SAS]</acronym><!-- /@w --> does not work on Windows. See <a href="#iESS_0028SAS_0029_002d_002dCommon-problems">iESS(SAS)–Common problems</a>.
4348 <li><acronym>ESS[SAS]</acronym> mode for editing <acronym>SAS</acronym><!-- /@w --> language files works very well.
4352 You can use batch. See <a href="#ESS_0028SAS_0029_002d_002dBatch-SAS-processes">ESS(SAS)–Batch SAS processes</a>.
4354 <p>Or you can mark regions with the mouse and submit the code with
4357 </ul>
4359 <!-- Local Variables: -->
4360 <!-- TeX-master: "ess.texi" -->
4361 <!-- End: -->
4362 <!-- node-name, next, previous, up -->
4364 <p><hr>
4370 </div>
4376 <li><a accesskey="2" href="#ESS_0028BUGS_0029_002d_002dCommand-files">ESS(BUGS)--Command files</a>
4378 </ul>
4383 extension. ESS provides 5 features. First, BUGS syntax is described to allow
4384 for proper fontification of statements, distributions, functions, commands and
4385 comments in BUGS model files, command files and log files. Second,
4386 ESS creates templates for the command file from the model file so that
4387 a BUGS batch process can be defined by a single file. Third, ESS
4388 provides a BUGS batch script that allows ESS to set BUGS batch
4389 parameters. Fourth, key sequences are defined to create a command
4390 file and submit a BUGS batch process. Lastly, interactive submission of BUGS
4391 commands is also supported.
4393 <!-- node-name, next, previous, up -->
4395 <p><hr>
4398 Next: <a rel="next" accesskey="n" href="#ESS_0028BUGS_0029_002d_002dCommand-files">ESS(BUGS)--Command files</a>,
4402 </div>
4406 <p>Model files (with the .bug extension) are edited in <acronym>ESS[BUGS]</acronym> mode. Two keys
4407 are bound for your use in <acronym>ESS[BUGS]</acronym>, F2 and F12. F2 performs the same action
4408 as it does in <acronym>ESS[SAS]</acronym>, See <a href="#ESS_0028SAS_0029_002d_002dFunction-keys-for-batch-processing">ESS(SAS)–Function keys for batch processing</a>.
4409 F12 performs the function
4410 ess-bugs-next-action which you will use a lot. Pressing F12 in an empty buffer
4411 for a model file will produce a template for you.
4413 <p><acronym>ESS[BUGS]</acronym> supports "replacement" variables. These variables are created as
4414 part of the template, i.e. with the first press of F12 in an empty buffer.
4415 They are named by
4416 all capitals and start with '%': %N, %DATA, %INIT, %MONITOR and %STATS.
4417 When you are finished editing your model file, pressing F12 will perform the
4418 necessary replacements and build your command file for you.
4420 <p>The %DATA variable appears in
4421 the line 'data in "%DATA";'. On the second press of F12, %DATA will be
4422 replaced by the model file name except it will have the .dat extension. If
4423 your data file is named something else, then change %DATA in the template to
4424 the appropriate file name and no replacement will occur.
4426 <p>The %INIT variable appears in
4427 the line 'inits in "%INIT";'. On the second press of F12, %INIT will be
4428 replaced by the model file name except it will have the .in extension. If
4429 your model will be generating it's own initial values, place a comment
4430 character, #, at the beginning of the line. Or, if your
4431 init file is named something else, then change %INIT in the template to the
4432 appropriate file name.
4435 it is still active. Notice that later on in the template you have the line
4436 'for (i in 1:N)'. The BUGS constant N is the number of rows in
4437 your data file. When you press F12, the data file is read and the number of
4438 lines are counted (after %DATA is resolved, if necessary). The number of
4439 lines replace the zero in the 'const N = 0' statement.
4441 <p>The %MONITOR variable appears on a line by itself. Although it is commented,
4442 it is still active. This line is a list of variables that you want monitored.
4443 When you press F12, the appropriate statements are created in
4444 the command file to monitor the list of variables. If the line is blank, then
4445 the list is populated with the variables from the 'var' statement.
4447 <p>The %STATS variable is similar to the %MONITOR variable. It is a list of
4448 variables for which summary statistics will be calculated. When you press
4449 F12, the appropriate statements will be generated in your command file.
4451 <p>Please note that the %DATA and %INIT variables are only replaced on the second
4452 press of F12, but the actions for %N, %MONITOR and %STATS are performed on
4453 each press of F12 if you re-visit the model file.
4455 <!-- node-name, next, previous, up -->
4457 <p><hr>
4460 Next: <a rel="next" accesskey="n" href="#ESS_0028BUGS_0029_002d_002dLog-files">ESS(BUGS)--Log files</a>,
4461 Previous: <a rel="previous" accesskey="p" href="#ESS_0028BUGS_0029_002d_002dModel-files">ESS(BUGS)--Model files</a>,
4464 </div>
4468 <p>To avoid extension name collision, .bmd is used for BUGS command files. When
4469 you have finished editing your model file and press F12, a command file is
4470 created if one does not already exist. However, the command file was
4471 created, it recognizes two "replacement" variables: %MONITOR and %STATS.
4473 <p>Two %MONITOR variables appears on lines by themselves. Although they are
4474 commented, they are still active. Between them appears the necessary
4475 statements to monitor the list of variables specified in the model file. The
4476 behavior of the %STATS variable is similar.
4478 <p>When you are finished editing your command file, pressing F12 again will submit
4479 your command file as a batch job. Batch scripts are provided for both DOS and
4480 Unix in the etc sub-directory of the ESS distribution. The DOS script is
4482 you to change the number of bins to use in the Griddy algorithm
4483 (Metropolis sampling). That is handled by the variable ess-bugs-default-bins
4484 which defaults to 32.
4486 <!-- node-name, next, previous, up -->
4488 <p><hr>
4491 Previous: <a rel="previous" accesskey="p" href="#ESS_0028BUGS_0029_002d_002dCommand-files">ESS(BUGS)--Command files</a>,
4494 </div>
4498 <p>To avoid extension name collision, .bog is used for BUGS log files. The BUGS
4499 batch script provided with ESS creates the .bog file from the .log file when
4500 the batch process completes. If you need to look at the .log file while
4502 you modify the auto-mode-alist variable. If you have done so, then you
4503 may find F2 useful to refresh the .log if the batch process over-writes or
4504 appends it.
4506 <!-- node-name, next, previous, up -->
4508 <p><hr>
4510 Next: <a rel="next" accesskey="n" href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>,
4514 </div>
4518 <p>ESS has a few miscellaneous features, which didn't fit anywhere else.
4528 </ul>
4530 <!-- node-name, next, previous, up -->
4532 <p><hr>
4538 </div>
4542 <p>ESS provides Font-Lock (see <a href="emacs.html#Faces">Using Multiple Typefaces</a>) patterns for Inferior S Mode, S
4543 Mode, and S Transcript Mode buffers.
4545 To activate highlighting, you need to turn on Font Lock mode in the
4546 appropriate buffers. This can be done on a per-buffer basis with
4553 <p>The font-lock patterns are defined in three variables, which you may
4554 modify if desired:
4557 — Variable: <b>inferior-ess-font-lock-keywords</b><var><a name="index-inferior_002dess_002dfont_002dlock_002dkeywords-197"></a></var><br>
4558 <blockquote><p>Font-lock patterns for Inferior ESS Mode. The default value
4559 highlights prompts, inputs, assignments, output messages, vector and
4560 matrix labels, and literals such as `<samp><span class="samp">NA</span></samp>' and <code>TRUE</code>.
4561 </p></blockquote></div>
4564 — Variable: <b>ess-mode-font-lock-keywords</b><var><a name="index-ess_002dmode_002dfont_002dlock_002dkeywords-198"></a></var><br>
4565 <blockquote><p>Font-lock patterns for ESS programming mode. The default value
4566 highlights function names, literals, assignments, source functions and
4567 reserved words.
4568 </p></blockquote></div>
4571 — Variable: <b>ess-trans-font-lock-keywords</b><var><a name="index-ess_002dtrans_002dfont_002dlock_002dkeywords-199"></a></var><br>
4572 <blockquote><p>Font-lock patterns for ESS Transcript Mode. The default value
4573 highlights the same patterns as in Inferior ESS Mode.
4574 </p></blockquote></div>
4576 <!-- node-name, next, previous, up -->
4578 <p><hr>
4584 </div>
4588 <p>Emacs and XEmacs have facilities for highlighting the parenthesis
4589 matching the parenthesis at point. This feature is very useful when
4590 trying to examine which parentheses match each other. This highlighting
4591 also indicates when parentheses are not matching. Depending on what
4592 version of emacs you use, one of the following should work in your
4593 initialisation file:
4596 (show-paren-mode t) ;for Emacs
4597 </pre>
4598 <!-- node-name, next, previous, up -->
4600 <p><hr>
4606 </div>
4610 <p><a name="index-graphics-200"></a>One of the main features of the <code>S</code> package is its ability to
4611 generate high-resolution graphics plots, and ESS provides a number of
4612 features for dealing with such plots.
4618 </ul>
4620 <!-- node-name, next, previous, up -->
4622 <p><hr>
4628 </div>
4632 <p>This is the simplest (and least desirable) method of using graphics
4634 based plots which can be contained within the ESS process buffer
4635 itself. To start using character graphics, issue the S command
4637 </pre>
4638 <p><a name="index-printer_0028_0029-201"></a>(the <code>width=79</code> argument prevents Emacs line-wrapping at column
4640 a different number of columns.) Plotting commands do not generate
4642 is issued, which displays the current figure.
4644 <!-- node-name, next, previous, up -->
4646 <p><hr>
4652 </div>
4656 <p><a name="index-X-windows-202"></a>Of course, the ideal way to use graphics with ESS is to use a windowing
4657 system. Under X11, this requires that the DISPLAY environment
4658 variable be appropriately set, which may not always be the case within
4659 your Emacs process. ESS provides a facility for setting the value of
4660 DISPLAY before the ESS process is started if the variable
4664 <!-- node-name, next, previous, up -->
4666 <p><hr>
4671 </div>
4676 S+6.1 and newer on Windows contains a java library that supports graphics. Send
4677 the commands:
4680 java.graph()
4681 </pre>
4683 interaction and graphics within S-PLUS. (Thanks to Tim Hesterberg for
4684 this information.)
4686 <!-- node-name, next, previous, up -->
4688 <p><hr>
4694 </div>
4698 <p>Imenu is an Emacs tool for providing mode-specific buffer indexes. In
4699 some of the ESS editing modes (currently SAS and S), support for Imenu
4700 is provided. For example, in S mode buffers, the menubar should display
4701 an item called "Imenu-S". Within this menubar you will then be offered
4702 bookmarks to particular parts of your source file (such as the starting
4703 point of each function definition).
4705 <p>Imenu works by searching your buffer for lines that match what ESS
4706 thinks is the beginning of a suitable entry, e.g. the beginning of a
4707 function definition. To examine the regular expression that ESS uses,
4711 <!-- node-name, next, previous, up -->
4713 <p><hr>
4719 </div>
4723 <p>The R and S editing modes have support for a toolbar. This toolbar
4724 provides icons to act as shortcuts for starting new S/R processes, or
4725 for evaluating regions of your source buffers. The toolbar should be
4726 present if your emacs can display images. See <a href="#Customization">Customization</a>, for ways
4727 to change the toolbar.
4729 <!-- node-name, next, previous, up -->
4731 <p><hr>
4737 </div>
4741 <p>The Emacs tags facility can be used to navigate around your files
4742 containing definitions of S functions. This facility is independent of
4743 ESS usage, but is written here since ESS users may wish to take
4744 advantage of TAGS facility. Read more about emacs tags in an emacs
4745 manual.
4747 <p>Etags, the program that generates the TAGS file, does not yet know the
4748 syntax to recognise function definitions in S files. Hence, you will
4749 need to provide a regexp that matches your function definitions. Here
4750 is an example call (broken over two lines; type as one line) that should
4751 be appropriate.
4755 </pre>
4756 <p>This will find entries in your source file of the form:
4759 </pre>
4761 change the single quotes to double quotes.
4763 <!-- node-name, next, previous, up -->
4765 <p><hr>
4770 </div>
4774 <p>Ess-rdired provides a dired-like buffer for viewing, editing and
4775 plotting objects in your current R session. If you are used to using
4776 the dired (directory editor) facility in Emacs, this mode gives you
4777 similar functionality for R objects.
4779 <p>To get started, first make sure you can load ess-rdired. Add the
4780 following to your .emacs and then restart emacs.
4782 "View *R* objects in a dired-like buffer." t)
4783 </pre>
4785 variables, such as:
4790 z <- TRUE
4791 </pre>
4793 objects in your current environment and display it in a new window:
4795 s numeric 100
4796 x numeric 3
4797 y numeric 20
4798 z logical 1
4799 </pre>
4801 mode. For example, with your point on the line of a variable, `p' will
4802 plot the object, `v' will view it, and `d' will mark the object for
4803 deletion (`x' will actually perform the deletion).
4805 <!-- node-name, next, previous, up@chapter Using S4 -->
4807 <p><hr>
4814 </div>
4822 </ul>
4825 <p><hr>
4828 Previous: <a rel="previous" accesskey="p" href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>,
4829 Up: <a rel="up" accesskey="u" href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>
4831 </div>
4837 <ul>
4839 cannot be used while the user is entering a multi-line command. The
4840 only real fix in this situation is to use another ESS process.
4843 buffer in the wrong place when point is at the same position as the last
4844 process output. This proves difficult to fix, in general, as we need to
4847 <li>It's possible to clear the modification flag (say, by saving the buffer)
4848 with the edit buffer not having been loaded into S.
4850 <li>Backup files can sometimes be left behind, even when
4854 to hang.
4856 <li>The function-based commands don't always work as expected on functions
4857 whose body is not a parenthesized or compound expression, and don't even
4858 recognize anonymous functions (i.e. functions not assigned to any
4859 variable).
4861 <li>Multi-line commands could be handled better by the command history
4862 mechanism.
4863 </ul>
4865 <!-- node-name, next, previous, up -->
4867 <p><hr>
4871 Up: <a rel="up" accesskey="u" href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>
4873 </div>
4877 <p><a name="index-Bug-reports-206"></a><a name="index-ess_002dsubmit_002dbug_002dreport-207"></a>
4879 <p>Please send bug reports, suggestions etc. to
4882 <p>The easiest way to do this is within Emacs by typing
4886 <p>This also gives the maintainers valuable information about your
4887 installation which may help us to identify or even fix the bug.
4889 <p>If Emacs reports an error, backtraces can help us debug the problem.
4890 Type "M-x set-variable RET debug-on-error RET t RET". Then run the
4891 command that causes the error and you should see a *Backtrace* buffer
4892 containing debug information; send us that buffer.
4894 <p>Note that comments, suggestions, words of praise and large cash
4895 donations are also more than welcome.
4897 <!-- node-name, next, previous, up -->
4899 <p><hr>
4902 Up: <a rel="up" accesskey="u" href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>
4904 </div>
4908 <p>There is a mailing list for discussions and announcements relating to
4909 ESS. Join the list by sending an e-mail with "subscribe ess-help" (or
4910 "help") in the body to <a href="mailto:ess-help-request@stat.math.ethz.ch">ess-help-request@stat.math.ethz.ch</a>;
4911 contributions to the list may be mailed to
4912 <a href="mailto:ess-help@stat.math.ethz.ch">ess-help@stat.math.ethz.ch</a>. Rest assured, this is a fairly
4913 low-volume mailing list.
4915 <p>The purposes of the mailing list include
4917 <ul>
4918 <li> helping users of ESS to get along with it.
4919 <li> discussing aspects of using ESS on Emacs and XEmacs.
4920 <li> suggestions for improvements.
4921 <li> announcements of new releases of ESS.
4922 <li> posting small patches to ESS.
4923 </ul>
4925 <!-- _not_yet_ @node Help OS, Installation, Help for Statistical Packages, Top -->
4926 <!-- _not_yet_ @comment node-name, next, previous, up -->
4927 <!-- _not_yet_ @chapter Help, arranged by Operating System -->
4928 <!-- _not_yet_ -->
4929 <!-- _not_yet_ @menu -->
4930 <!-- _not_yet_ * Unix installation:: -->
4931 <!-- _not_yet_ * Microsoft Windows installation:: -->
4932 <!-- _not_yet_ * System dependent:: Other variables you may need to change -->
4933 <!-- _not_yet_ @end menu -->
4934 <!-- node-name, next, previous, up -->
4936 <p><hr>
4939 Previous: <a rel="previous" accesskey="p" href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>,
4942 </div>
4947 ESS can be easily customized to your taste simply by including the
4948 appropriate lines in your <samp><span class="file">.emacs</span></samp> file. There are numerous
4949 variables which affect the behavior of ESS in certain situations which
4950 can be modified to your liking. Keybindings may be set or changed to
4951 your preferences, and for per-buffer customizations hooks are also
4952 available.
4954 <p>Most of these variables can be viewed and set using the Custom facility
4956 ESS variables that can be customized. Variables are grouped by subject
4957 to make it easy to find related variables.
4959 <!-- Stephen deleted incomplete variable list Wed 25 Aug 2004. -->
4961 <p><hr>
4967 </div>
4973 <!-- @unnumbered Command and Function Index -->
4974 <!-- @printindex fn -->
4975 <!-- node-name, next, previous, up -->
4977 <p><hr>
4979 Next: <a rel="next" accesskey="n" href="#Variable-and-command-index">Variable and command index</a>,
4983 </div>
4990 <li><a href="#index-g_t_0040file_007b_002eemacs_007d-file-176"><samp><span class="file">.emacs</span></samp> file</a>: <a href="#Source-Directories">Source Directories</a></li>
4991 <li><a href="#index-g_t_0040file_007b_002eemacs_007d-file-159"><samp><span class="file">.emacs</span></samp> file</a>: <a href="#Indenting">Indenting</a></li>
4992 <li><a href="#index-aborting-S-commands-111">aborting S commands</a>: <a href="#Other">Other</a></li>
4993 <li><a href="#index-aborting-the-ESS-process-116">aborting the ESS process</a>: <a href="#Other">Other</a></li>
4994 <li><a href="#index-arguments-to-S-program-31">arguments to S program</a>: <a href="#Customizing-startup">Customizing startup</a></li>
4996 <li><a href="#index-autosaving-171">autosaving</a>: <a href="#Source-Files">Source Files</a></li>
4997 <li><a href="#index-Bug-reports-206">Bug reports</a>: <a href="#Reporting-Bugs">Reporting Bugs</a></li>
5001 <li><a href="#index-command-history-72">command history</a>: <a href="#Command-History">Command History</a></li>
5002 <li><a href="#index-command_002dline-completion-41">command-line completion</a>: <a href="#Completion">Completion</a></li>
5003 <li><a href="#index-command_002dline-editing-35">command-line editing</a>: <a href="#Command_002dline-editing">Command-line editing</a></li>
5004 <li><a href="#index-commands-33">commands</a>: <a href="#Entering-commands">Entering commands</a></li>
5006 <li><a href="#index-comments-in-S-154">comments in S</a>: <a href="#Indenting">Indenting</a></li>
5007 <li><a href="#index-completion-in-edit-buffer-162">completion in edit buffer</a>: <a href="#Other-edit-buffer-commands">Other edit buffer commands</a></li>
5008 <li><a href="#index-completion-of-object-names-40">completion of object names</a>: <a href="#Completion">Completion</a></li>
5009 <li><a href="#index-completion-on-file-names-49">completion on file names</a>: <a href="#Completion">Completion</a></li>
5010 <li><a href="#index-completion-on-lists-48">completion on lists</a>: <a href="#Completion">Completion</a></li>
5011 <li><a href="#index-completion_002c-when-prompted-for-object-names-125">completion, when prompted for object names</a>: <a href="#Edit-buffer">Edit buffer</a></li>
5012 <li><a href="#index-creating-new-objects-126">creating new objects</a>: <a href="#Edit-buffer">Edit buffer</a></li>
5014 <li><a href="#index-customization-208">customization</a>: <a href="#Customization">Customization</a></li>
5016 <li><a href="#index-debugging-S-functions-152">debugging S functions</a>: <a href="#Evaluating-code">Evaluating code</a></li>
5017 <li><a href="#index-deleting-output-59">deleting output</a>: <a href="#Last-command">Last command</a></li>
5018 <li><a href="#index-directories-16">directories</a>: <a href="#Starting-up">Starting up</a></li>
5019 <li><a href="#index-dump-file-directories-174">dump file directories</a>: <a href="#Source-Directories">Source Directories</a></li>
5020 <li><a href="#index-dump-file-names-172">dump file names</a>: <a href="#Source-Directories">Source Directories</a></li>
5021 <li><a href="#index-dump-files-165">dump files</a>: <a href="#Source-Files">Source Files</a></li>
5022 <li><a href="#index-dump-files-129">dump files</a>: <a href="#Edit-buffer">Edit buffer</a></li>
5023 <li><a href="#index-echoing-commands-when-evaluating-139">echoing commands when evaluating</a>: <a href="#Evaluating-code">Evaluating code</a></li>
5024 <li><a href="#index-edit-buffer-123">edit buffer</a>: <a href="#Edit-buffer">Edit buffer</a></li>
5025 <li><a href="#index-editing-commands-73">editing commands</a>: <a href="#Command-History">Command History</a></li>
5026 <li><a href="#index-editing-functions-122">editing functions</a>: <a href="#Editing">Editing</a></li>
5027 <li><a href="#index-editing-transcripts-70">editing transcripts</a>: <a href="#Saving-transcripts">Saving transcripts</a></li>
5028 <li><a href="#index-emacsclient-109">emacsclient</a>: <a href="#Emacsclient">Emacsclient</a></li>
5029 <li><a href="#index-entering-commands-32">entering commands</a>: <a href="#Entering-commands">Entering commands</a></li>
5031 <li><a href="#index-ESS-process-buffer-17">ESS process buffer</a>: <a href="#Starting-up">Starting up</a></li>
5032 <li><a href="#index-ESS-process-directory-13">ESS process directory</a>: <a href="#Starting-up">Starting up</a></li>
5033 <li><a href="#index-evaluating-code-with-echoed-commands-140">evaluating code with echoed commands</a>: <a href="#Evaluating-code">Evaluating code</a></li>
5034 <li><a href="#index-evaluating-S-expressions-141">evaluating S expressions</a>: <a href="#Evaluating-code">Evaluating code</a></li>
5035 <li><a href="#index-Font_002dlock-mode-195">Font-lock mode</a>: <a href="#Highlighting">Highlighting</a></li>
5036 <li><a href="#index-formatting-source-code-158">formatting source code</a>: <a href="#Indenting">Indenting</a></li>
5039 <li><a href="#index-highlighting-196">highlighting</a>: <a href="#Highlighting">Highlighting</a></li>
5040 <li><a href="#index-historic-backups-170">historic backups</a>: <a href="#Source-Files">Source Files</a></li>
5043 <li><a href="#index-installation-9">installation</a>: <a href="#Installation">Installation</a></li>
5044 <li><a href="#index-interactive-use-of-S-2">interactive use of S</a>: <a href="#Introduction">Introduction</a></li>
5045 <li><a href="#index-interrupting-S-commands-112">interrupting S commands</a>: <a href="#Other">Other</a></li>
5046 <li><a href="#index-introduction-1">introduction</a>: <a href="#Introduction">Introduction</a></li>
5047 <li><a href="#index-keyboard-short-cuts-94">keyboard short cuts</a>: <a href="#Hot-keys">Hot keys</a></li>
5048 <li><a href="#index-killing-temporary-buffers-106">killing temporary buffers</a>: <a href="#Hot-keys">Hot keys</a></li>
5049 <li><a href="#index-killing-the-ESS-process-100">killing the ESS process</a>: <a href="#Hot-keys">Hot keys</a></li>
5050 <li><a href="#index-lists_002c-completion-on-47">lists, completion on</a>: <a href="#Completion">Completion</a></li>
5051 <li><a href="#index-motion-in-transcript-mode-119">motion in transcript mode</a>: <a href="#Transcript-Mode">Transcript Mode</a></li>
5052 <li><a href="#index-multi_002dline-commands_002c-resubmitting-67">multi-line commands, resubmitting</a>: <a href="#Transcript-resubmit">Transcript resubmit</a></li>
5053 <li><a href="#index-Multiple-ESS-processes-19">Multiple ESS processes</a>: <a href="#Multiple-ESS-processes">Multiple ESS processes</a></li>
5054 <li><a href="#index-new-objects_002c-creating-127">new objects, creating</a>: <a href="#Edit-buffer">Edit buffer</a></li>
5056 <li><a href="#index-pages-in-the-process-buffer-54">pages in the process buffer</a>: <a href="#Transcript">Transcript</a></li>
5057 <li><a href="#index-paging-commands-in-help-buffers-185">paging commands in help buffers</a>: <a href="#Help">Help</a></li>
5058 <li><a href="#index-paragraphs-in-the-process-buffer-53">paragraphs in the process buffer</a>: <a href="#Transcript">Transcript</a></li>
5059 <li><a href="#index-parsing-errors-135">parsing errors</a>: <a href="#Error-Checking">Error Checking</a></li>
5060 <li><a href="#index-process-buffer-18">process buffer</a>: <a href="#Starting-up">Starting up</a></li>
5061 <li><a href="#index-process-names-20">process names</a>: <a href="#Multiple-ESS-processes">Multiple ESS processes</a></li>
5062 <li><a href="#index-programming-in-S-5">programming in S</a>: <a href="#Introduction">Introduction</a></li>
5063 <li><a href="#index-project-work-in-S-169">project work in S</a>: <a href="#Source-Files">Source Files</a></li>
5064 <li><a href="#index-quitting-from-ESS-99">quitting from ESS</a>: <a href="#Hot-keys">Hot keys</a></li>
5065 <li><a href="#index-re_002dexecuting-commands-74">re-executing commands</a>: <a href="#Command-History">Command History</a></li>
5066 <li><a href="#index-reading-long-command-outputs-56">reading long command outputs</a>: <a href="#Last-command">Last command</a></li>
5067 <li><a href="#index-Remote-Computers-22">Remote Computers</a>: <a href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a></li>
5068 <li><a href="#index-reverting-function-definitions-130">reverting function definitions</a>: <a href="#Edit-buffer">Edit buffer</a></li>
5070 <li><a href="#index-search-list-178">search list</a>: <a href="#Source-Directories">Source Directories</a></li>
5072 <li><a href="#index-sending-input-34">sending input</a>: <a href="#Entering-commands">Entering commands</a></li>
5073 <li><a href="#index-starting-directory-14">starting directory</a>: <a href="#Starting-up">Starting up</a></li>
5074 <li><a href="#index-starting-ESS-10">starting ESS</a>: <a href="#Starting-up">Starting up</a></li>
5075 <li><a href="#index-stepping-through-code-151">stepping through code</a>: <a href="#Evaluating-code">Evaluating code</a></li>
5076 <li><a href="#index-STERM-107">STERM</a>: <a href="#Statistical-Process-running-in-ESS_003f">Statistical Process running in ESS?</a></li>
5078 <li><a href="#index-temporary-buffers-194">temporary buffers</a>: <a href="#Help">Help</a></li>
5079 <li><a href="#index-temporary-buffers_002c-killing-105">temporary buffers, killing</a>: <a href="#Hot-keys">Hot keys</a></li>
5081 <li><a href="#index-transcript-file-29">transcript file</a>: <a href="#Customizing-startup">Customizing startup</a></li>
5082 <li><a href="#index-transcript-file-names-69">transcript file names</a>: <a href="#Saving-transcripts">Saving transcripts</a></li>
5083 <li><a href="#index-transcript-mode-motion-118">transcript mode motion</a>: <a href="#Transcript-Mode">Transcript Mode</a></li>
5084 <li><a href="#index-transcripts-of-S-sessions-4">transcripts of S sessions</a>: <a href="#Introduction">Introduction</a></li>
5085 <li><a href="#index-using-S-interactively-3">using S interactively</a>: <a href="#Introduction">Introduction</a></li>
5087 <li><a href="#index-working-directory-179">working directory</a>: <a href="#Source-Directories">Source Directories</a></li>
5088 <li><a href="#index-working-directory-15">working directory</a>: <a href="#Starting-up">Starting up</a></li>
5091 <p><hr>
5096 </div>
5103 <li><a href="#index-attach_0028_0029-96"><code>attach()</code></a>: <a href="#Hot-keys">Hot keys</a></li>
5104 <li><a href="#index-backward_002dkill_002dword-37"><code>backward-kill-word</code></a>: <a href="#Command_002dline-editing">Command-line editing</a></li>
5105 <li><a href="#index-comint_002dbackward_002dmatching_002dinput-62"><code>comint-backward-matching-input</code></a>: <a href="#Process-buffer-motion">Process buffer motion</a></li>
5106 <li><a href="#index-comint_002dbol-39"><code>comint-bol</code></a>: <a href="#Command_002dline-editing">Command-line editing</a></li>
5107 <li><a href="#index-comint_002dcopy_002dold_002dinput-65"><code>comint-copy-old-input</code></a>: <a href="#Transcript-resubmit">Transcript resubmit</a></li>
5108 <li><a href="#index-comint_002ddelimiter_002dargument_002dlist-82"><code>comint-delimiter-argument-list</code></a>: <a href="#History-expansion">History expansion</a></li>
5109 <li><a href="#index-comint_002ddynamic_002dcomplete-42"><code>comint-dynamic-complete</code></a>: <a href="#Completion">Completion</a></li>
5110 <li><a href="#index-comint_002dforward_002dmatching_002dinput-63"><code>comint-forward-matching-input</code></a>: <a href="#Process-buffer-motion">Process buffer motion</a></li>
5111 <li><a href="#index-comint_002dinput_002dring_002dsize-75"><code>comint-input-ring-size</code></a>: <a href="#Command-History">Command History</a></li>
5112 <li><a href="#index-comint_002dinterrupt_002dsubjob-110"><code>comint-interrupt-subjob</code></a>: <a href="#Other">Other</a></li>
5113 <li><a href="#index-comint_002dkill_002dinput-38"><code>comint-kill-input</code></a>: <a href="#Command_002dline-editing">Command-line editing</a></li>
5114 <li><a href="#index-comint_002dkill_002doutput-58"><code>comint-kill-output</code></a>: <a href="#Last-command">Last command</a></li>
5115 <li><a href="#index-comint_002dnext_002dinput-77"><code>comint-next-input</code></a>: <a href="#Command-History">Command History</a></li>
5116 <li><a href="#index-comint_002dnext_002dinput-61"><code>comint-next-input</code></a>: <a href="#Process-buffer-motion">Process buffer motion</a></li>
5117 <li><a href="#index-comint_002dnext_002dmatching_002dinput-79"><code>comint-next-matching-input</code></a>: <a href="#Command-History">Command History</a></li>
5118 <li><a href="#index-comint_002dnext_002dmatching_002dinput_002dfrom_002dinput-81"><code>comint-next-matching-input-from-input</code></a>: <a href="#Command-History">Command History</a></li>
5119 <li><a href="#index-comint_002dprevious_002dinput-76"><code>comint-previous-input</code></a>: <a href="#Command-History">Command History</a></li>
5120 <li><a href="#index-comint_002dprevious_002dinput-60"><code>comint-previous-input</code></a>: <a href="#Process-buffer-motion">Process buffer motion</a></li>
5121 <li><a href="#index-comint_002dprevious_002dmatching_002dinput-78"><code>comint-previous-matching-input</code></a>: <a href="#Command-History">Command History</a></li>
5122 <li><a href="#index-comint_002dprevious_002dmatching_002dinput_002dfrom_002dinput-80"><code>comint-previous-matching-input-from-input</code></a>: <a href="#Command-History">Command History</a></li>
5123 <li><a href="#index-comint_002dshow_002dmaximum_002doutput-55"><code>comint-show-maximum-output</code></a>: <a href="#Last-command">Last command</a></li>
5124 <li><a href="#index-comint_002dshow_002doutput-57"><code>comint-show-output</code></a>: <a href="#Last-command">Last command</a></li>
5125 <li><a href="#index-comint_002dstop_002dsubjob-114"><code>comint-stop-subjob</code></a>: <a href="#Other">Other</a></li>
5126 <li><a href="#index-comment_002dcolumn-155"><code>comment-column</code></a>: <a href="#Indenting">Indenting</a></li>
5127 <li><a href="#index-dump_0028_0029-131"><code>dump()</code></a>: <a href="#Edit-buffer">Edit buffer</a></li>
5128 <li><a href="#index-ess_002dabort-113"><code>ess-abort</code></a>: <a href="#Other">Other</a></li>
5129 <li><a href="#index-ess_002dask_002dabout_002ddisplay-203"><code>ess-ask-about-display</code></a>: <a href="#X11">X11</a></li>
5130 <li><a href="#index-ess_002dask_002dabout_002dtransfile-68"><code>ess-ask-about-transfile</code></a>: <a href="#Saving-transcripts">Saving transcripts</a></li>
5131 <li><a href="#index-ess_002dask_002dabout_002dtransfile-28"><code>ess-ask-about-transfile</code></a>: <a href="#Customizing-startup">Customizing startup</a></li>
5132 <li><a href="#index-ess_002dask_002dfor_002dess_002ddirectory-26"><code>ess-ask-for-ess-directory</code></a>: <a href="#Customizing-startup">Customizing startup</a></li>
5133 <li><a href="#index-ess_002dbeginning_002dof_002dfunction-160"><code>ess-beginning-of-function</code></a>: <a href="#Other-edit-buffer-commands">Other edit buffer commands</a></li>
5134 <li><a href="#index-ess_002dchange_002dsp_002dregexp-50"><code>ess-change-sp-regexp</code></a>: <a href="#Completion-details">Completion details</a></li>
5135 <li><a href="#index-ess_002dcleanup-193"><code>ess-cleanup</code></a>: <a href="#Help">Help</a></li>
5136 <li><a href="#index-ess_002dcleanup-103"><code>ess-cleanup</code></a>: <a href="#Hot-keys">Hot keys</a></li>
5137 <li><a href="#index-ess_002ddelete_002ddump_002dfiles-166"><code>ess-delete-dump-files</code></a>: <a href="#Source-Files">Source Files</a></li>
5138 <li><a href="#index-ess_002ddescribe_002dhelp_002dmode-183"><code>ess-describe-help-mode</code></a>: <a href="#Help">Help</a></li>
5139 <li><a href="#index-ess_002ddirectory-177"><code>ess-directory</code></a>: <a href="#Source-Directories">Source Directories</a></li>
5140 <li><a href="#index-ess_002ddirectory-27"><code>ess-directory</code></a>: <a href="#Customizing-startup">Customizing startup</a></li>
5141 <li><a href="#index-ess_002ddisplay_002dhelp_002don_002dobject-182"><code>ess-display-help-on-object</code></a>: <a href="#Help">Help</a></li>
5142 <li><a href="#index-ess_002ddump_002dfilename_002dtemplate-173"><code>ess-dump-filename-template</code></a>: <a href="#Source-Directories">Source Directories</a></li>
5143 <li><a href="#index-ess_002ddump_002dobject_002dinto_002dedit_002dbuffer-124"><code>ess-dump-object-into-edit-buffer</code></a>: <a href="#Edit-buffer">Edit buffer</a></li>
5144 <li><a href="#index-ess_002ddump_002dobject_002dinto_002dedit_002dbuffer-117"><code>ess-dump-object-into-edit-buffer</code></a>: <a href="#Other">Other</a></li>
5145 <li><a href="#index-ESS_002delsewhere-24"><code>ESS-elsewhere</code></a>: <a href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a></li>
5146 <li><a href="#index-ess_002dend_002dof_002dfunction-161"><code>ess-end-of-function</code></a>: <a href="#Other-edit-buffer-commands">Other edit buffer commands</a></li>
5147 <li><a href="#index-ess_002deval_002dbuffer-148"><code>ess-eval-buffer</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
5148 <li><a href="#index-ess_002deval_002dfunction-144"><code>ess-eval-function</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
5149 <li><a href="#index-ess_002deval_002dfunction_002dand_002dgo-145"><code>ess-eval-function-and-go</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
5150 <li><a href="#index-ess_002deval_002dline-142"><code>ess-eval-line</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
5151 <li><a href="#index-ess_002deval_002dline_002dand_002dgo-143"><code>ess-eval-line-and-go</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
5152 <li><a href="#index-ess_002deval_002dline_002dand_002dstep-189"><code>ess-eval-line-and-step</code></a>: <a href="#Help">Help</a></li>
5153 <li><a href="#index-ess_002deval_002dline_002dand_002dstep-150"><code>ess-eval-line-and-step</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
5154 <li><a href="#index-ess_002deval_002dregion-190"><code>ess-eval-region</code></a>: <a href="#Help">Help</a></li>
5155 <li><a href="#index-ess_002deval_002dregion-146"><code>ess-eval-region</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
5156 <li><a href="#index-ess_002deval_002dregion_002dand_002dgo-147"><code>ess-eval-region-and-go</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
5157 <li><a href="#index-ess_002deval_002dvisibly_002dp-137"><code>ess-eval-visibly-p</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
5158 <li><a href="#index-ess_002dexecute-92"><code>ess-execute</code></a>: <a href="#Hot-keys">Hot keys</a></li>
5159 <li><a href="#index-ess_002dexecute_002dattach-95"><code>ess-execute-attach</code></a>: <a href="#Hot-keys">Hot keys</a></li>
5160 <li><a href="#index-ess_002dexecute_002din_002dprocess_002dbuffer-83"><code>ess-execute-in-process-buffer</code></a>: <a href="#Hot-keys">Hot keys</a></li>
5161 <li><a href="#index-ess_002dexecute_002din_002dtb-153"><code>ess-execute-in-tb</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
5162 <li><a href="#index-ess_002dexecute_002dobjects-84"><code>ess-execute-objects</code></a>: <a href="#Hot-keys">Hot keys</a></li>
5163 <li><a href="#index-ess_002dexecute_002dsearch-88"><code>ess-execute-search</code></a>: <a href="#Hot-keys">Hot keys</a></li>
5164 <li><a href="#index-ess_002dfancy_002dcomments-156"><code>ess-fancy-comments</code></a>: <a href="#Indenting">Indenting</a></li>
5165 <li><a href="#index-ess_002dfunction_002dtemplate-128"><code>ess-function-template</code></a>: <a href="#Edit-buffer">Edit buffer</a></li>
5166 <li><a href="#index-ess_002dkeep_002ddump_002dfiles-167"><code>ess-keep-dump-files</code></a>: <a href="#Source-Files">Source Files</a></li>
5167 <li><a href="#index-ess_002dlist_002dobject_002dcompletions-46"><code>ess-list-object-completions</code></a>: <a href="#Completion">Completion</a></li>
5168 <li><a href="#index-ess_002dload_002dfile-132"><code>ess-load-file</code></a>: <a href="#Loading">Loading</a></li>
5169 <li><a href="#index-ess_002dload_002dfile-97"><code>ess-load-file</code></a>: <a href="#Hot-keys">Hot keys</a></li>
5170 <li><a href="#index-ess_002dmode_002dfont_002dlock_002dkeywords-198"><code>ess-mode-font-lock-keywords</code></a>: <a href="#Highlighting">Highlighting</a></li>
5171 <li><a href="#index-ess_002dparse_002derrors-136"><code>ess-parse-errors</code></a>: <a href="#Error-Checking">Error Checking</a></li>
5172 <li><a href="#index-ess_002dparse_002derrors-98"><code>ess-parse-errors</code></a>: <a href="#Hot-keys">Hot keys</a></li>
5174 <li><a href="#index-ess_002dquit-115"><code>ess-quit</code></a>: <a href="#Other">Other</a></li>
5175 <li><a href="#index-ess_002dremote-23"><code>ess-remote</code></a>: <a href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a></li>
5176 <li><a href="#index-ess_002drequest_002da_002dprocess-21"><code>ess-request-a-process</code></a>: <a href="#Multiple-ESS-processes">Multiple ESS processes</a></li>
5177 <li><a href="#index-ess_002dresynch-51"><code>ess-resynch</code></a>: <a href="#Completion-details">Completion details</a></li>
5178 <li><a href="#index-ess_002dsearch_002dlist-180"><code>ess-search-list</code></a>: <a href="#Source-Directories">Source Directories</a></li>
5179 <li><a href="#index-ess_002dskip_002dto_002dhelp_002dsection-188"><code>ess-skip-to-help-section</code></a>: <a href="#Help">Help</a></li>
5180 <li><a href="#index-ess_002dskip_002dto_002dnext_002dsection-186"><code>ess-skip-to-next-section</code></a>: <a href="#Help">Help</a></li>
5181 <li><a href="#index-ess_002dskip_002dto_002dprevious_002dsection-187"><code>ess-skip-to-previous-section</code></a>: <a href="#Help">Help</a></li>
5182 <li><a href="#index-ess_002dsource_002ddirectory-175"><code>ess-source-directory</code></a>: <a href="#Source-Directories">Source Directories</a></li>
5183 <li><a href="#index-ess_002dsubmit_002dbug_002dreport-207"><code>ess-submit-bug-report</code></a>: <a href="#Reporting-Bugs">Reporting Bugs</a></li>
5184 <li><a href="#index-ess_002dswitch_002dto_002dend_002dof_002dESS-191"><code>ess-switch-to-end-of-ESS</code></a>: <a href="#Help">Help</a></li>
5185 <li><a href="#index-ess_002dswitch_002dto_002dend_002dof_002dESS-163"><code>ess-switch-to-end-of-ESS</code></a>: <a href="#Other-edit-buffer-commands">Other edit buffer commands</a></li>
5186 <li><a href="#index-ess_002dswitch_002dto_002dESS-164"><code>ess-switch-to-ESS</code></a>: <a href="#Other-edit-buffer-commands">Other edit buffer commands</a></li>
5187 <li><a href="#index-ess_002dtrans_002dfont_002dlock_002dkeywords-199"><code>ess-trans-font-lock-keywords</code></a>: <a href="#Highlighting">Highlighting</a></li>
5188 <li><a href="#index-ess_002dtranscript_002dclean_002dregion-71"><code>ess-transcript-clean-region</code></a>: <a href="#Saving-transcripts">Saving transcripts</a></li>
5189 <li><a href="#index-ess_002dtranscript_002dcopy_002dcommand-121"><code>ess-transcript-copy-command</code></a>: <a href="#Resubmit">Resubmit</a></li>
5190 <li><a href="#index-ess_002dtranscript_002dsend_002dcommand-120"><code>ess-transcript-send-command</code></a>: <a href="#Resubmit">Resubmit</a></li>
5191 <li><a href="#index-ess_002dtranscript_002dsend_002dcommand_002dand_002dmove-66"><code>ess-transcript-send-command-and-move</code></a>: <a href="#Transcript-resubmit">Transcript resubmit</a></li>
5192 <li><a href="#index-exit_0028_0029-102"><code>exit()</code></a>: <a href="#Hot-keys">Hot keys</a></li>
5193 <li><a href="#index-inferior_002dess_002dfont_002dlock_002dkeywords-197"><code>inferior-ess-font-lock-keywords</code></a>: <a href="#Highlighting">Highlighting</a></li>
5194 <li><a href="#index-inferior_002dess_002dprogram-30"><code>inferior-ess-program</code></a>: <a href="#Customizing-startup">Customizing startup</a></li>
5195 <li><a href="#index-inferior_002dess_002dsend_002dinput-64"><code>inferior-ess-send-input</code></a>: <a href="#Transcript-resubmit">Transcript resubmit</a></li>
5196 <li><a href="#index-inferior_002dess_002dsend_002dinput-36"><code>inferior-ess-send-input</code></a>: <a href="#Command_002dline-editing">Command-line editing</a></li>
5197 <li><a href="#index-objects_0028_0029-85"><code>objects()</code></a>: <a href="#Hot-keys">Hot keys</a></li>
5198 <li><a href="#index-printer_0028_0029-201"><code>printer()</code></a>: <a href="#printer">printer</a></li>
5199 <li><a href="#index-q_0028_0029-101"><code>q()</code></a>: <a href="#Hot-keys">Hot keys</a></li>
5201 <li><a href="#index-S_002belsewhere-25"><code>S+elsewhere</code></a>: <a href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a></li>
5202 <li><a href="#index-search_0028_0029-89"><code>search()</code></a>: <a href="#Hot-keys">Hot keys</a></li>
5203 <li><a href="#index-search_0028_0029-44"><code>search()</code></a>: <a href="#Completion">Completion</a></li>
5204 <li><a href="#index-source_0028_0029-138"><code>source()</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
5205 <li><a href="#index-source_0028_0029-133"><code>source()</code></a>: <a href="#Loading">Loading</a></li>
5206 <li><a href="#index-STERM-108"><code>STERM</code></a>: <a href="#Statistical-Process-running-in-ESS_003f">Statistical Process running in ESS?</a></li>
5207 </ul>
5210 <ul>
5213 <ul>
5219 </li></ul>
5221 <ul>
5225 </li></ul>
5226 <li><a name="toc_Interactive-ESS" href="#Interactive-ESS">3 Interacting with statistical programs</a>
5227 <ul>
5233 </li></ul>
5234 <li><a name="toc_Entering-commands" href="#Entering-commands">4 Interacting with the ESS process</a>
5235 <ul>
5240 <ul>
5245 </li></ul>
5249 <li><a href="#Statistical-Process-running-in-ESS_003f">4.8 Is the Statistical Process running under ESS?</a>
5252 </li></ul>
5253 <li><a name="toc_Transcript-Mode" href="#Transcript-Mode">5 Manipulating saved transcript files</a>
5254 <ul>
5257 </li></ul>
5259 <ul>
5261 <li><a href="#iESS_0028S_0029_002d_002dInferior-ESS-processes">6.2 iESS[S]–Inferior ESS processes</a>
5262 <li><a href="#ESS_002dhelp_002d_002dassistance-with-viewing-help">6.3 ESS-help–assistance with viewing help</a>
5264 <li><a href="#Scenarios-for-use-_0028possibilities_002d_002dbased-on-actual-usage_0029">6.5 Scenarios for use (possibilities–based on actual usage)</a>
5265 <li><a href="#Customization-Examples-and-Solutions-to-Problems">6.6 Customization Examples and Solutions to Problems</a>
5266 </li></ul>
5268 <ul>
5277 </li></ul>
5278 <li><a name="toc_Editing-R-documentation-files" href="#Editing-R-documentation-files">8 Editing R documentation files</a>
5281 <ul>
5282 <li><a href="#ESS_0028SAS_0029_002d_002dDesign-philosophy">10.1 ESS(SAS)–Design philosophy</a>
5285 <li><a href="#ESS_0028SAS_0029_002d_002dBatch-SAS-processes">10.4 ESS(SAS)–Batch SAS processes</a>
5286 <li><a href="#ESS_0028SAS_0029_002d_002dFunction-keys-for-batch-processing">10.5 ESS(SAS)–Function keys for batch processing</a>
5287 <li><a href="#iESS_0028SAS_0029_002d_002dInteractive-SAS-processes">10.6 iESS(SAS)–Interactive SAS processes</a>
5288 <li><a href="#iESS_0028SAS_0029_002d_002dCommon-problems">10.7 iESS(SAS)–Common problems</a>
5291 </li></ul>
5293 <ul>
5297 </li></ul>
5299 <ul>
5303 <ul>
5307 </li></ul>
5312 </li></ul>
5313 <li><a name="toc_Mailing-lists_002fbug-reports" href="#Mailing-lists_002fbug-reports">13 Bugs and Bug Reporting, Mailing Lists</a>
5314 <ul>
5318 </li></ul>
5322 <li><a name="toc_Variable-and-command-index" href="#Variable-and-command-index">Variable and command index</a>
5323 </li></ul>
5324 </div>
5327 <hr>
5328 <a name="texinfo-footnotes-in-document"></a><h4>Footnotes</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small>
5329 require the files.el patch to revert-buffer for the Local Variables
5330 updating problem</p>
5332 <p class="footnote"><small>[<a name="fn-2" href="#fnd-2">2</a>]</small> The variable <code>ess-change-sp-regexp</code> is a regular
5333 expression matching commands which change the search list. You will
5334 need to modify this variable if you have defined custom commands (other
5335 than <code>attach</code>, <code>detach</code>, <code>collection</code> or <code>library</code>)
5336 which modify the search list.</p>
5338 <p><hr></div>
5340 </body></html>