~ubuntu-branches/ubuntu/hardy/ess/hardy

« back to all changes in this revision

Viewing changes to doc/ess.info-3

  • Committer: Bazaar Package Importer
  • Author(s): Camm Maguire
  • Date: 2005-03-22 13:48:07 UTC
  • mfrom: (1.2.1 upstream) (2.1.2 hoary)
  • Revision ID: james.westby@ubuntu.com-20050322134807-9mpmbb799jugf248
Tags: 5.2.6-1
* New upstream release
* chmod -R u+w on orig source

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
This is ess.info, produced by makeinfo version 4.0 from ess.texi.
2
 
 
3
 
START-INFO-DIR-ENTRY
4
 
* ESS: (ess).    Emacs Speaks Statistics (S/R, SAS, XLisp-Stat, etc).
5
 
END-INFO-DIR-ENTRY
6
 
 
7
 
ESS -- Emacs Speaks Statistics
8
 
******************************
9
 
 
10
 
   Originally known as S-mode, written by Doug Bates, Ed Kademan, Frank
11
 
Ritter, and David Smith.
12
 
 
13
 
   Currently maintained by A.J. (Tony) Rossini, Richard M. Heiberger,
14
 
Kurt Hornik, Martin Maechler, and Rodney Sparapani.
15
 
 
16
 
   This file documents `ESS', a GNU Emacs package for running
17
 
`S(plus)', `R', `XLisp-Stat', `SAS' and potentially any other
18
 
interactive `statistical' languages in an `inferior' buffer, editing
19
 
source code in these languages and interacting with the running program.
20
 
 
21
 
   This documentation relates to Version 5.1.19 of `ESS'.
22
 
 
23
 
   Original Info Author: David M. Smith (<D.M.Smith@lancaster.ac.uk>),
24
 
Department of Mathematics and Statistics, Lancaster University, UK.
25
 
 
26
 
   Current Info Author: A.J. Rossini
27
 
(<rossini@biostat.washington.edu>), Department of Biostatistics,
28
 
University of Washington, Seattle, WA 98185, USA
29
 
 
30
 
 
31
 
File: ess.info,  Node: Microsoft Windows installation,  Prev: Unix installation,  Up: Top
32
 
 
33
 
Microsoft Windows installation
34
 
==============================
35
 
 
36
 
   For Microsoft Windows installation, please follow the next steps:
37
 
(see separate instructions above for UNIX *Note Unix installation::.
38
 
 
39
 
  1.     cd to a directory where you keep emacs lisp files, or create a
40
 
     new    directory (for example, `c:\emacs\') to hold the
41
 
     distribution.  This    directory will be referred to below as "the
42
 
     ESS distribution    directory".  It will contain, at the end,
43
 
     either the tar file    `ess-5.1.20.tar.gz' or the zip file
44
 
     `ess-5.1.20.zip', and a    directory    for the ESS source, which
45
 
     will be termed "the ESS-5.1.20 source    directory".
46
 
 
47
 
  2.       Retrieve the compressed tar file `ess-5.1.20.tar.gz' or the
48
 
        zipped file `ess-5.1.20.zip' from one of the FTP or WWW
49
 
     archive sites      via FTP (or HTTP).  Be aware that http browsers
50
 
     on Windows      frequently change the "." and "-" characters in
51
 
     filenames to other      punctuation.  Please change the names back
52
 
     to their original form.
53
 
 
54
 
  3.       Copy `ess-5.1.20.tar.gz' to the location where you want the
55
 
        ess-5.1.20 directory, for example to
56
 
     `c:\emacs\ess-5.1.20.tar.gz', and cd there.  For example,
57
 
 
58
 
                       cd c:\emacs
59
 
 
60
 
     Extract the files from the distribution, which will unpack
61
 
     into a subdirectory, `ess-5.1.20'.
62
 
                        gunzip ess-5.1.20.tar.gz
63
 
                        tar vxf ess-5.1.20.tar
64
 
                (or: `gunzip < ess-5.1.20.tar.gz | tar vxf -' ).
65
 
        (or: from the zip file: `unzip ess-5.1.20.zip')
66
 
 
67
 
     The `tar' command will extract files into the current directory.
68
 
 
69
 
     Do not create `ess-5.1.20' yourself, or you will get an extra level
70
 
         of   depth to your directory structure.
71
 
 
72
 
  4.      Windows users will usually be able to use the
73
 
     `lisp/ess-site.el'      as distributed.  Only rarely will changes
74
 
     be needed.
75
 
 
76
 
  5.       Windows users will need to make sure that the directories
77
 
     for the      software they will be using is in the PATH
78
 
     environment variable.  On      Windows 9x, add lines similar to
79
 
     the following to your      `c:\autoexec.bat'      file:
80
 
                   path=%PATH%;c:\progra~1\spls2000\cmd
81
 
          On Windows NT/2000, add the directories to the PATH using the
82
 
         MyComputer menu.  Note that the directory containing the
83
 
     program is      added to the PATH, not the program itself.  One
84
 
     such line is needed      for each software program.  Be sure to
85
 
     use the abbreviation      `progra~1' and not the long version with
86
 
     embedded blanks.  Use      backslashes "\".
87
 
 
88
 
  6.       Add the line
89
 
                      (load "/PATH/ess-site")
90
 
          to your .emacs (or _emacs) file (or default.el or
91
 
     site-init.el, for      a site-wide installation).  Replace `/PATH'
92
 
     above with the      value of ess-lisp-directory as defined in
93
 
     `ess-site.el'.  Use      forwardslashes `/'.
94
 
 
95
 
  7.       (OPTIONAL) If you are running Sqpe or R, you might consider
96
 
        installing the database files.  From within (X)Emacs, `C-x d'
97
 
     to      the   directory containing ESS.  Now:
98
 
                           M-x Sqpe+6
99
 
            (get running.  once you have reached the SPLUS prompt, do:)
100
 
                           M-x ess-create-object-name-db
101
 
            (this will create the file `ess-s+6-namedb.el'; if it isn't
102
 
     in the        ESS directory, move it there).
103
 
 
104
 
     Then, completions will be autoloaded and will not be regenerated
105
 
       for every session.
106
 
 
107
 
     For R, do the same, using
108
 
                          M-x R
109
 
          and then `M-x ess-create-object-name-db' creating
110
 
     `ess-r-namedb.el'; if it isn't in the ESS directory, move it
111
 
     there).
112
 
 
113
 
  8.       For more information on using ESS in your daily work, see the
114
 
         files doc/README.SPLUS4WIN, doc/README.S, doc/README.SAS, and
115
 
         doc/README.XLispStat.
116
 
 
117
 
     For the impatient, the quick version of usage follows:
118
 
 
119
 
  9.       To edit statistical programs, load the files with the
120
 
     requisite      extensions  (".sas" for SAS, ".S" or "s" or "q" or
121
 
     "Q" for S-PLUS,      ".r" or ".R" for R, and ".lsp"   for
122
 
     XLispStat).
123
 
 
124
 
 10.       To run statistical processes under (X)Emacs:
125
 
 
126
 
     Run S-PLUS 6.x or 2000 with:
127
 
                        M-x S+6
128
 
            (or `M-x S').  You will then be      asked for a pathname
129
 
     ("S starting data directory?"), from which to      start the
130
 
     process.  The prompt will propose your current directory      as
131
 
     the default.  Similarly for S-PLUS 6.x.  Send lines or regions
132
 
     from the emacs buffer containing your S program (for example,
133
 
     `myfile.s') to the S-Plus Commands Window with the      `C-c C-n'
134
 
     or `C-c C-r' keys.
135
 
 
136
 
     Run S-PLUS 6.x or 2000 inside an emacs buffer
137
 
                        M-x Sqpe+6
138
 
          You will then be asked for a pathname ("S starting data
139
 
     directory?"), from which to start the process.  The prompt will
140
 
      propose your current directory as the default.  Similarly for
141
 
     S-PLUS      6.x.  Send lines or regions from the emacs buffer
142
 
     containing your S      program (for example, `myfile.s') to the
143
 
     *S+6* buffer with the      `C-c C-n' or `C-c C-r' keys.  You do
144
 
     not have access to      interactive graphics in      this mode.
145
 
     You get Unix-like behavior, in particular the entire
146
 
     transcript is available for emacs-style search commands.
147
 
 
148
 
     If you wish to run R, you can start it with:
149
 
                        M-x R
150
 
 
151
 
     XLispStat can not currently be run with
152
 
                        M-x XLS
153
 
          Hopefully, this will change.  However, you can still edit with
154
 
         Emacs, and cut and paste the results into the XLispStat
155
 
     *Listener* Window under Microsoft Windows.
156
 
 
157
 
     SAS for Windows uses the batch access with function keys that is
158
 
       described in `doc/README.SAS'.  The user can also edit SAS files
159
 
         in an `ESS[SAS]' buffer and than manually copy and paste them
160
 
     into      an Editor window in the SAS Display Manager.
161
 
 
162
 
     For Windows, inferior SAS in an `iESS[SAS]' buffer does not work
163
 
       on the local machine.  It does work over a network connection to
164
 
         SAS running on a remote Unix computer.
165
 
 
166
 
     Reason:  we use ddeclient to interface with programs and SAS
167
 
     doesn't      provide the corresponding ddeserver capability.
168
 
 
169
 
 11. That's it!
170
 
 
171
 
 
172
 
 
173
 
File: ess.info,  Node: System dependent,  Prev: Installation,  Up: Installation
174
 
 
175
 
Other variables you may need to change
176
 
======================================
177
 
 
178
 
   If you run the S program (from the shell) with a command other than
179
 
`Splus' you will need to set the variable `inferior-ess-program' to the
180
 
name of the appropriate program by including a line such as
181
 
     (setq inferior-ess-program "S+")
182
 
 
183
 
in your `.emacs' file
184
 
 
185
 
(substituting `S+' for the name of your S program.)
186
 
 
187
 
   If you need to call this program with any arguments, the variable you
188
 
need to set is dependent on the value of `inferior-ess-program'; for
189
 
example if it is `"Splus"', set the variable `inferior-Splus-args' to a
190
 
string of arguments to the `Splus' program.  If `inferior-ess-program'
191
 
has some other value, substitute the `Splus' part of
192
 
`inferior-Splus-args' with the appropriate program name.  There aren't
193
 
many instances where you need to call S with arguments, however: in
194
 
particular do not call the S program with the `-e' command-line editor
195
 
argument since ESS provides this feature for you.
196
 
 
197
 
   If you are running Splus (the enhanced version of S from Statsci) you
198
 
may also need to set the variable `S-plus' to `t'.  If your value of
199
 
`inferior-ess-program' is `"S+"' or `Splus' this will not be necessary,
200
 
however; `S-plus' defaults to `t' in this case.
201
 
 
202
 
   Finally, if you use a non-standard prompt within S, you will need to
203
 
set the variable `inferior-ess-prompt' to a regular expression which
204
 
will match both the primary prompt (`"> "' by default) and the
205
 
continuing prompt (default of `"+ "'.) The default value of this
206
 
variable matches S's default prompts.  For example, if you use (`"$ "')
207
 
as your primary prompt (you have `options(prompt="$ ")' in your
208
 
`.First' function), add the following line to your `.emacs':
209
 
     (setq inferior-ess-prompt "^\\(\\+\\|[^\\$]*\\$\\) *")
210
 
 
211
 
You will also need to set the variable `inferior-ess-primary-prompt' to
212
 
a regular expression which matches the primary prompt only.  Do not
213
 
anchor the regexp to the beginning of the line with `^'.  Once again,
214
 
the default value matches S's default prompt; in the example above the
215
 
appropriate value would be `"[^\\$]*\\$ *"'.
216
 
 
217
 
   Once these variables are set appropriately, ESS should work on any
218
 
system.
219
 
 
220
 
 
221
 
File: ess.info,  Node: Customization,  Next: Key Index,  Prev: Installation,  Up: Top
222
 
 
223
 
Customizing ESS
224
 
***************
225
 
 
226
 
   ESS can be easily customized to your taste simply by including the
227
 
appropriate lines in your `.emacs' file.  There are numerous variables
228
 
which affect the behavior of ESS in certain situations which can be
229
 
modified to your liking.  Keybindings may be set or changed to your
230
 
preferences, and for per-buffer customizations hooks are also available.
231
 
 
232
 
* Menu:
233
 
 
234
 
* Variables::                   Variables for customization
235
 
* Hooks::                       Customizing ESS with hooks
236
 
* Keybindings::                 Changing the default ESS keybindings
237
 
 
238
 
 
239
 
File: ess.info,  Node: Variables,  Next: Hooks,  Prev: Customization,  Up: Customization
240
 
 
241
 
Variables for customization
242
 
===========================
243
 
 
244
 
   ESS is easily customizable by means of setting variables in your
245
 
`.emacs' file.  In most cases, you can change defaults by including
246
 
lines of the form
247
 
     (setq VARIABLE-NAME VALUE)
248
 
 
249
 
in your `.emacs'.
250
 
 
251
 
   In what follows, variable names will be listed along with their
252
 
descriptions and default values.  Just substitute the variable name and
253
 
the new value into the template above.
254
 
 
255
 
* Menu:
256
 
 
257
 
* Variables for starting ESS::  Variables for starting ESS
258
 
* Dump file variables::         Variables for dump files
259
 
* Indentation variables::       Variables controlling indentation
260
 
* Variables controlling interaction::  Variables controlling interaction
261
 
                                        with the ESS process
262
 
 
263
 
 
264
 
File: ess.info,  Node: Variables for starting ESS,  Next: Dump file variables,  Prev: Variables,  Up: Variables
265
 
 
266
 
Variables for starting ESS
267
 
--------------------------
268
 
 
269
 
 - User Option: ess-ask-for-ess-directory
270
 
     Default: `t'
271
 
     If this variable has a non-`nil' value, then every time ESS is run
272
 
     with `M-x S' you will be prompted for a directory to use as the
273
 
     working directory for your S session; this directory should have a
274
 
     `.Data' subdirectory.  If the value of `ess-ask-for-ess-directory'
275
 
     is `nil', the value of `S-directory' is used as the working
276
 
     directory.
277
 
 
278
 
 - User Option: S-directory
279
 
     Default: Your home directory
280
 
     The working directory for your S session if
281
 
     `ess-ask-for-ess-directory' is `nil', and the default when
282
 
     prompting for a directory if it is not.  For example, you may wish
283
 
     to set this to the value of the current buffer's working directory
284
 
     before starting S by adding the following line to your `.emacs'
285
 
     file (*note Hooks::)
286
 
          (setq ess-pre-run-hook
287
 
             '((lambda () (setq S-directory default-directory))))
288
 
 
289
 
 - User Option: ess-ask-about-display
290
 
     Default: `nil'
291
 
     If this variable has a non-`nil' value, then every time ESS is run
292
 
     with `M-x S' you will be asked for a value for the `DISPLAY'
293
 
     environment variable to be used in the current S session.  If this
294
 
     variable is not set correctly, S will not be able to create any
295
 
     windows under the X windowing environment.  Completion is provided
296
 
     over the `X-displays-list' variable; the default is the current
297
 
     value of `DISPLAY'.  This feature is useful is you often run S on
298
 
     a different display than that of the machine you are running S
299
 
     from.  If `ess-ask-about-display' is `nil', the current value of
300
 
     `DISPLAY' is used.
301
 
 
302
 
 - User Option: X-displays-list
303
 
     Default: `'(":0.0")'
304
 
     List of possible values for the `DISPLAY' environment variable,
305
 
     provided for completion when prompting for such a value.
306
 
 
307
 
 
308
 
File: ess.info,  Node: Dump file variables,  Next: Indentation variables,  Prev: Variables for starting ESS,  Up: Variables
309
 
 
310
 
Variables for dump files
311
 
------------------------
312
 
 
313
 
 - User Option: ess-insert-function-templates
314
 
     Default: `t'
315
 
     If this variable has a non-`nil' value, then dumping a
316
 
     non-existent object will result in the edit buffer containing a
317
 
     skeleton function definition, ready for editing.
318
 
 
319
 
 - User Option: ess-source-directory
320
 
     Default: `"/tmp/"'
321
 
     Directory name (ending in `/') in which dump files are placed.
322
 
     This should always be a writable directory.
323
 
 
324
 
 - User Option: ess-source-directory-generator
325
 
     Default: `nil'
326
 
     Alternative, dynamic method of specifying the directory for dump
327
 
     files.
328
 
 
329
 
 - User Option: ess-dump-filename-template
330
 
     Default: USER_NAME`.'OBJECT_NAME`.S'
331
 
     Naming system to use for dumped object files.  *Note Source
332
 
     Directories::, for details of this and the previous two variables.
333
 
 
334
 
 - User Option: ess-keep-dump-files
335
 
     Default: `nil'
336
 
     Boolean flag signifying whether to keep dump files or to delete
337
 
     them after each use.  *Note Source Files::, for more details.
338
 
 
339
 
 
340
 
File: ess.info,  Node: Indentation variables,  Next: Variables controlling interaction,  Prev: Dump file variables,  Up: Variables
341
 
 
342
 
Variables controlling indentation
343
 
---------------------------------
344
 
 
345
 
 - User Option: ess-tab-always-indent
346
 
     Default: `t'
347
 
     If non-`nil', then `TAB' in the edit buffer always indents the
348
 
     current line, regardless of the position of point in the line.
349
 
     Otherwise, indentation is only performed if point is in the lines
350
 
     indentation, and a tab character is inserted is point is after the
351
 
     first nonblank character.
352
 
 
353
 
 - User Option: ess-auto-newline
354
 
     Default: `nil'
355
 
     Non-`nil' means automatically newline before and after braces
356
 
     inserted in S code.
357
 
 
358
 
   The following variables control amounts of indentation.  These
359
 
variables automatically become buffer-local in any ESS buffer, and so
360
 
setting any of these variables has effect in the current buffer only.
361
 
 
362
 
 - User Option: ess-indent-level
363
 
     Default: 2
364
 
     Extra indentation of S statement sub-block with respect to
365
 
     enclosing braces.
366
 
 
367
 
 - User Option: ess-brace-imaginary-offset
368
 
     Default: 0
369
 
     Extra indentation (over sub-block indentation) for block following
370
 
     an open brace which follows on the same line as a statement.
371
 
 
372
 
 - User Option: ess-brace-offset
373
 
     Default: 0
374
 
     Extra indentation for braces, compared with other text in same
375
 
     context.
376
 
 
377
 
 - User Option: ess-continued-statement-offset
378
 
     Default: 0
379
 
     Extra indent for lines not starting new statements.
380
 
 
381
 
 - User Option: ess-continued-brace-offset
382
 
     Default: 0
383
 
     Extra indent for substatements that start with open-braces.  This
384
 
     is in addition to `ess-continued-statement-offset'.
385
 
 
386
 
 - User Option: ess-arg-function-offset
387
 
     Default: 2
388
 
     Extra indent for arguments of function `foo' when it is called as
389
 
     the value of an argument to another function in `arg=foo(...)'
390
 
     form.  If not number, the statements are indented at
391
 
     open-parenthesis following `foo'.
392
 
 
393
 
 - User Option: ess-expression-offset
394
 
     Default: 4
395
 
     Extra indent for internal substatements of the call to
396
 
     `expression()' specified in
397
 
          `obj <- expression(...)'
398
 
 
399
 
     form.  If not a number, the statements are indented at
400
 
     open-parenthesis following `expression'.
401
 
 
402
 
 - User Option: ess-else-offset
403
 
     Default: 2
404
 
     Extra indentation of the `else' clause with respect to the
405
 
     corresponding `if'.
406
 
 
407
 
In addition, a number of default styles are defined for you (in
408
 
`ess-style-alist'):
409
 
 
410
 
 - User Option: ess-default-style
411
 
     Default: `DEFAULT'
412
 
     The default formatting style to use in edit buffers.  The DEFAULT
413
 
     style uses the values of the above indentation variables at
414
 
     load-time, so that changing these variables in your `.emacs' file
415
 
     will affect your buffer defaults.  Other styles are: `GNU', `BSD',
416
 
     `K&R', `CLB', and `C++'.  See `ess-cust.el' for the complete
417
 
     definitions of the styles.  *Note Edit buffer::, for more details.
418
 
 
419
 
 
420
 
File: ess.info,  Node: Variables controlling interaction,  Prev: Indentation variables,  Up: Variables
421
 
 
422
 
Variables controlling interaction with the ESS process
423
 
------------------------------------------------------
424
 
 
425
 
 - User Option: comint-input-ring-size
426
 
     Default: 50
427
 
     Number of commands to store in the command history.
428
 
 
429
 
 - User Option: ess-execute-in-process-buffer
430
 
     Default: `nil'
431
 
     If this is `nil', then the `ess-execute-' commands (*note Other::)
432
 
     output to a temporary buffer.  Otherwise, the output goes to the
433
 
     ESS process.
434
 
 
435
 
 - User Option: ess-eval-visibly-p
436
 
     Default: `nil'
437
 
     If non-`nil', then the `ess-eval-' commands (*note Edit buffer::)
438
 
     echo the S commands in the process buffer by default.  In any
439
 
     case, passing a prefix argument to the eval command reverses the
440
 
     meaning of this variable.
441
 
 
442
 
 
443
 
File: ess.info,  Node: Hooks,  Next: Keybindings,  Prev: Variables,  Up: Customization
444
 
 
445
 
Customizing ESS with hooks
446
 
==========================
447
 
 
448
 
   ESS provides the following hooks:
449
 
 
450
 
 - Hook: ess-mode-hook
451
 
     Called every time `ESS' is run.
452
 
 
453
 
 - Hook: ess-mode-load-hook
454
 
     Called just after the file `ess.el' is loaded.  Useful for setting
455
 
     up your keybindings, etc.
456
 
 
457
 
 - Hook: ess-pre-run-hook
458
 
     Called before the ESS process is started (e.g., with `M-x S').
459
 
     Good for setting up your directory.
460
 
 
461
 
 - Hook: ess-post-run-hook
462
 
     Called just after the ESS process starts up.  This can be used to
463
 
     evaluate ESS code at the start of a session, with
464
 
     `ess-eval-visibly', say.
465
 
 
466
 
 - Hook: inferior-ess-mode-hook
467
 
     For customizing inferior ess mode.  Called after inferior-ess-mode
468
 
     is entered and variables have been initialized.
469
 
 
470
 
 - Hook: ess-help-mode-hook
471
 
     Called every time when entering ess-help-mode (i.e., an ESS help
472
 
     buffer is generated).
473
 
 
474
 
 - Hook: ess-send-input-hook
475
 
     Called just before line input is sent to the process.
476
 
 
477
 
 - Hook: ess-transcript-mode-hook
478
 
     For customizing ESS transcript mode.
479
 
 
480
 
 
481
 
File: ess.info,  Node: Keybindings,  Prev: Hooks,  Up: Customization
482
 
 
483
 
Changing the default ESS keybindings
484
 
====================================
485
 
 
486
 
   ESS provides a separate keymaps (keymap variables) for ESS process
487
 
buffers, edit buffers and for help buffers.  The key bindings in the
488
 
edit buffers further depend on the language and dialect in use.
489
 
 
490
 
 - Keymap: inferior-ess-mode-map
491
 
     Keymap used in the ESS process buffer.  The bindings from
492
 
     `comint-mode-map' are automatically inherited.
493
 
 
494
 
 - Keymap: ess-mode-map
495
 
     Keymap used within edit (ess-mode) buffers.
496
 
 
497
 
 - Keymap: ess-eval-map
498
 
     Keymap used within edit buffers for sending ESS code to the running
499
 
     process.
500
 
 
501
 
 - Keymap: ess-help-mode-map
502
 
     Keymap used within help buffers.  In addition, `ess-help-sec-map'
503
 
     is the keymap for the `s' prefix key.  Keys defined in
504
 
     `ess-help-sec-keys-alist' are automatically inserted into this
505
 
     keymap when ESS is loaded.
506
 
 
507
 
 - Keymap: ess-transcript-mode-map
508
 
     Keymap used within ESS transcript buffers.
509
 
 
510
 
 
511
 
File: ess.info,  Node: Key Index,  Next: Command Index,  Prev: Customization,  Up: Top
512
 
 
513
 
Key (Character) Index
514
 
*********************
515
 
 
516
 
* Menu:
517
 
 
518
 
File: ess.info,  Node: Command Index,  Next: Concept Index,  Prev: Key Index,  Up: Top
519
 
 
520
 
Command and Function Index
521
 
**************************
522
 
 
523
 
* Menu:
524
 
 
525
 
* comint-backward-matching-input:        Process buffer motion.
526
 
* comint-forward-matching-input:         Process buffer motion.
527
 
 
528
 
 
529
 
File: ess.info,  Node: Concept Index,  Next: Variable and command index,  Prev: Command Index,  Up: Top
530
 
 
531
 
Concept Index
532
 
*************
533
 
 
534
 
* Menu:
535
 
 
536
 
* .Data directory:                       Variables for starting ESS.
537
 
* .emacs file <1>:                       Variables for starting ESS.
538
 
* .emacs file <2>:                       System dependent.
539
 
* .emacs file <3>:                       Indenting.
540
 
* .emacs file <4>:                       Source Directories.
541
 
* .emacs file:                           Variables.
542
 
* .First function:                       System dependent.
543
 
* aborting S commands:                   Other.
544
 
* aborting the ESS process:              Other.
545
 
* arguments to S program <1>:            System dependent.
546
 
* arguments to S program:                Customizing startup.
547
 
* authors:                               Credits.
548
 
* autosaving:                            Source Files.
549
 
* Bug reports:                           Reporting Bugs.
550
 
* bugs:                                  Bugs.
551
 
* cleaning up:                           Hot keys.
552
 
* comint:                                Credits.
553
 
* command history:                       Command History.
554
 
* command to run S program:              System dependent.
555
 
* command-line completion:               Completion.
556
 
* command-line editing:                  Command-line editing.
557
 
* commands:                              Entering commands.
558
 
* comments:                              Source Files.
559
 
* comments in S:                         Indenting.
560
 
* completion in edit buffer:             Other edit buffer commands.
561
 
* completion of object names:            Completion.
562
 
* completion on file names:              Completion.
563
 
* completion on lists:                   Completion.
564
 
* completion, when prompted for object names: Edit buffer.
565
 
* continuing prompt:                     System dependent.
566
 
* creating new objects:                  Edit buffer.
567
 
* credits:                               Credits.
568
 
* customization:                         Customization.
569
 
* data frames:                           Completion.
570
 
* debugging S functions:                 Evaluating code.
571
 
* defaults:                              Variables.
572
 
* deleting output:                       Last command.
573
 
* directories <1>:                       Variables for starting ESS.
574
 
* directories:                           Starting Up.
575
 
* DISPLAY environment variable:          Variables for starting ESS.
576
 
* dump file directories:                 Source Directories.
577
 
* dump file names:                       Source Directories.
578
 
* dump files <1>:                        Source Files.
579
 
* dump files <2>:                        Edit buffer.
580
 
* dump files:                            Dump file variables.
581
 
* echoing commands when evaluating:      Evaluating code.
582
 
* edit buffer:                           Edit buffer.
583
 
* editing commands:                      Command History.
584
 
* editing functions:                     Editing.
585
 
* editing transcripts:                   Saving transcripts.
586
 
* entering commands:                     Entering commands.
587
 
* environment variables:                 Variables for starting ESS.
588
 
* errors:                                Error Checking.
589
 
* ESS process buffer:                    Starting Up.
590
 
* ESS process directory:                 Starting Up.
591
 
* evaluating code with echoed commands:  Evaluating code.
592
 
* evaluating S expressions:              Evaluating code.
593
 
* Font-lock mode:                        Highlighting.
594
 
* formatting source code <1>:            Indenting.
595
 
* formatting source code:                Indentation variables.
596
 
* graphics:                              Graphics.
597
 
* help files:                            Help.
598
 
* highlighting:                          Highlighting.
599
 
* historic backups:                      Source Files.
600
 
* hooks:                                 Hooks.
601
 
* hot keys:                              Hot keys.
602
 
* indentation:                           Indentation variables.
603
 
* indenting:                             Indenting.
604
 
* installation:                          Installation.
605
 
* interactive use of S:                  Introduction.
606
 
* interrupting S commands:               Other.
607
 
* introduction:                          Introduction.
608
 
* keyboard short cuts:                   Hot keys.
609
 
* killing temporary buffers:             Hot keys.
610
 
* killing the ESS process:               Hot keys.
611
 
* lists, completion on:                  Completion.
612
 
* motion in transcript mode:             Transcript Mode.
613
 
* multi-line commands, resubmitting:     Transcript resubmit.
614
 
* Multiple ESS processes:                Multiple ESS processes.
615
 
* name of S program:                     System dependent.
616
 
* new objects, creating:                 Edit buffer.
617
 
* objects:                               Hot keys.
618
 
* pages in the process buffer:           Transcript.
619
 
* paging commands in help buffers:       Help.
620
 
* paragraphs in the process buffer:      Transcript.
621
 
* parsing errors:                        Error Checking.
622
 
* primary prompt:                        System dependent.
623
 
* process buffer:                        Starting Up.
624
 
* process names:                         Multiple ESS processes.
625
 
* programming in S:                      Introduction.
626
 
* project work in S:                     Source Files.
627
 
* prompts in S:                          System dependent.
628
 
* quitting from ESS:                     Hot keys.
629
 
* re-executing commands:                 Command History.
630
 
* reading long command outputs:          Last command.
631
 
* reverting function definitions:        Edit buffer.
632
 
* running S:                             Starting Up.
633
 
* S program name:                        System dependent.
634
 
* search list <1>:                       Hot keys.
635
 
* search list:                           Source Directories.
636
 
* sending input:                         Entering commands.
637
 
* Splus:                                 System dependent.
638
 
* starting directory <1>:                Variables for starting ESS.
639
 
* starting directory:                    Starting Up.
640
 
* starting ESS:                          Starting Up.
641
 
* stepping through code:                 Evaluating code.
642
 
* STERM:                                 Is the Statistical Process running under ESS?.
643
 
* tcsh:                                  Completion.
644
 
* temporary buffers:                     Help.
645
 
* temporary buffers, killing:            Hot keys.
646
 
* transcript:                            Transcript.
647
 
* transcript file:                       Customizing startup.
648
 
* transcript file names:                 Saving transcripts.
649
 
* transcript mode motion:                Transcript Mode.
650
 
* transcripts of S sessions:             Introduction.
651
 
* using S interactively:                 Introduction.
652
 
* variables:                             Variables.
653
 
* working directory <1>:                 Starting Up.
654
 
* working directory:                     Source Directories.
655
 
* X windows <1>:                         X11.
656
 
* X windows:                             Variables for starting ESS.
657
 
 
658
 
 
659
 
File: ess.info,  Node: Variable and command index,  Prev: Concept Index,  Up: Top
660
 
 
661
 
Variable and command index
662
 
**************************
663
 
 
664
 
* Menu:
665
 
 
666
 
* (exit):                                Hot keys.
667
 
* attach():                              Hot keys.
668
 
* backward-kill-word:                    Command-line editing.
669
 
* comint-bol:                            Command-line editing.
670
 
* comint-copy-old-input:                 Transcript resubmit.
671
 
* comint-delimiter-argument-list:        History expansion.
672
 
* comint-dynamic-complete:               Completion.
673
 
* comint-input-ring-size <1>:            Variables controlling interaction.
674
 
* comint-input-ring-size:                Command History.
675
 
* comint-interrupt-subjob:               Other.
676
 
* comint-kill-input:                     Command-line editing.
677
 
* comint-kill-output:                    Last command.
678
 
* comint-mode-map:                       Keybindings.
679
 
* comint-next-input <1>:                 Command History.
680
 
* comint-next-input:                     Process buffer motion.
681
 
* comint-next-matching-input:            Command History.
682
 
* comint-next-matching-input-from-input: Command History.
683
 
* comint-previous-input <1>:             Command History.
684
 
* comint-previous-input:                 Process buffer motion.
685
 
* comint-previous-matching-input:        Command History.
686
 
* comint-previous-matching-input-from-input: Command History.
687
 
* comint-show-maximum-output:            Last command.
688
 
* comint-show-output:                    Last command.
689
 
* comint-stop-subjob:                    Other.
690
 
* comment-column:                        Indenting.
691
 
* dump():                                Edit buffer.
692
 
* ess-abort:                             Other.
693
 
* ess-arg-function-offset:               Indentation variables.
694
 
* ess-ask-about-display <1>:             X11.
695
 
* ess-ask-about-display:                 Variables for starting ESS.
696
 
* ess-ask-about-transfile <1>:           Saving transcripts.
697
 
* ess-ask-about-transfile:               Customizing startup.
698
 
* ess-ask-for-ess-directory <1>:         Customizing startup.
699
 
* ess-ask-for-ess-directory:             Variables for starting ESS.
700
 
* ess-auto-newline:                      Indentation variables.
701
 
* ess-beginning-of-function:             Other edit buffer commands.
702
 
* ess-brace-imaginary-offset:            Indentation variables.
703
 
* ess-brace-offset:                      Indentation variables.
704
 
* ess-change-sp-regex:                   Completion details.
705
 
* ess-clean-region:                      Saving transcripts.
706
 
* ess-cleanup <1>:                       Help.
707
 
* ess-cleanup:                           Hot keys.
708
 
* ess-continued-brace-offset:            Indentation variables.
709
 
* ess-continued-statement-offset:        Indentation variables.
710
 
* ess-default-style:                     Indentation variables.
711
 
* ess-delete-dump-files:                 Source Files.
712
 
* ess-describe-help-mode:                Help.
713
 
* ess-directory <1>:                     Source Directories.
714
 
* ess-directory:                         Customizing startup.
715
 
* ess-display-help-on-object:            Help.
716
 
* ess-dump-filename-template <1>:        Dump file variables.
717
 
* ess-dump-filename-template:            Source Directories.
718
 
* ess-dump-object-into-edit-buffer <1>:  Other.
719
 
* ess-dump-object-into-edit-buffer:      Edit buffer.
720
 
* ess-else-offset:                       Indentation variables.
721
 
* ess-end-of-function:                   Other edit buffer commands.
722
 
* ess-eval-buffer:                       Evaluating code.
723
 
* ess-eval-function:                     Evaluating code.
724
 
* ess-eval-function-and-go:              Evaluating code.
725
 
* ess-eval-line:                         Evaluating code.
726
 
* ess-eval-line-and-go:                  Evaluating code.
727
 
* ess-eval-line-and-next-line:           Evaluating code.
728
 
* ess-eval-map:                          Keybindings.
729
 
* ess-eval-region <1>:                   Evaluating code.
730
 
* ess-eval-region:                       Help.
731
 
* ess-eval-region-and-go:                Evaluating code.
732
 
* ess-eval-visibly-p <1>:                Variables controlling interaction.
733
 
* ess-eval-visibly-p:                    Evaluating code.
734
 
* ess-execute:                           Hot keys.
735
 
* ess-execute-attach:                    Hot keys.
736
 
* ess-execute-in-process-buffer <1>:     Hot keys.
737
 
* ess-execute-in-process-buffer:         Variables controlling interaction.
738
 
* ess-execute-in-tb:                     Evaluating code.
739
 
* ess-execute-objects:                   Hot keys.
740
 
* ess-execute-search:                    Hot keys.
741
 
* ess-expression-offset:                 Indentation variables.
742
 
* ess-fancy-comments:                    Indenting.
743
 
* ESS-font-lock-keywords:                Highlighting.
744
 
* ess-function-template:                 Edit buffer.
745
 
* ess-help-mode-hook:                    Hooks.
746
 
* ess-help-mode-map:                     Keybindings.
747
 
* ess-help-sec-keys-alist:               Keybindings.
748
 
* ess-indent-level:                      Indentation variables.
749
 
* ess-inf-font-lock-keywords:            Highlighting.
750
 
* ess-insert-function-templates <1>:     Dump file variables.
751
 
* ess-insert-function-templates:         Edit buffer.
752
 
* ess-keep-dump-files <1>:               Dump file variables.
753
 
* ess-keep-dump-files:                   Source Files.
754
 
* ess-list-object-name-completions:      Completion.
755
 
* ess-load-file <1>:                     Loading.
756
 
* ess-load-file:                         Hot keys.
757
 
* ess-mode-hook:                         Hooks.
758
 
* ess-mode-load-hook:                    Hooks.
759
 
* ess-mode-map:                          Keybindings.
760
 
* ess-parse-errors <1>:                  Error Checking.
761
 
* ess-parse-errors:                      Hot keys.
762
 
* ess-plain-first-buffername:            Multiple ESS processes.
763
 
* ess-post-run-hook:                     Hooks.
764
 
* ess-pre-run-hook:                      Hooks.
765
 
* ess-quit <1>:                          Help.
766
 
* ess-quit:                              Other.
767
 
* ess-request-a-process:                 Multiple ESS processes.
768
 
* ess-resynch:                           Completion details.
769
 
* ess-search-list:                       Source Directories.
770
 
* ess-send-input-hook:                   Hooks.
771
 
* ess-skip-to-help-section:              Help.
772
 
* ess-skip-to-next-section:              Help.
773
 
* ess-skip-to-previous-section:          Help.
774
 
* ess-source-directory <1>:              Dump file variables.
775
 
* ess-source-directory:                  Source Directories.
776
 
* ess-source-directory-generator:        Dump file variables.
777
 
* ess-style-alist:                       Indentation variables.
778
 
* ess-submit-bug-report:                 Reporting Bugs.
779
 
* ess-switch-to-end-of-ESS <1>:          Help.
780
 
* ess-switch-to-end-of-ESS:              Other edit buffer commands.
781
 
* ess-switch-to-ESS:                     Other edit buffer commands.
782
 
* ess-tab-always-indent:                 Indentation variables.
783
 
* ess-trans-font-lock-keywords:          Highlighting.
784
 
* ess-transcript-copy-command:           Resubmit.
785
 
* ess-transcript-mode-hook:              Hooks.
786
 
* ess-transcript-mode-map:               Keybindings.
787
 
* ess-transcript-send-command:           Resubmit.
788
 
* ess-transcript-send-command-and-move:  Transcript resubmit.
789
 
* expression():                          Indentation variables.
790
 
* inferior-ess-mode-hook:                Hooks.
791
 
* inferior-ess-mode-map:                 Keybindings.
792
 
* inferior-ess-primary-prompt:           System dependent.
793
 
* inferior-ess-program <1>:              Customizing startup.
794
 
* inferior-ess-program:                  System dependent.
795
 
* inferior-ess-prompt:                   System dependent.
796
 
* inferior-ess-send-input <1>:           Command-line editing.
797
 
* inferior-ess-send-input:               Transcript resubmit.
798
 
* inferior-Splus-args:                   System dependent.
799
 
* objects():                             Hot keys.
800
 
* options():                             System dependent.
801
 
* printer():                             printer.
802
 
* q():                                   Hot keys.
803
 
* S <1>:                                 Variables for starting ESS.
804
 
* S <2>:                                 Starting Up.
805
 
* S:                                     Variables for starting ESS.
806
 
* S-directory:                           Variables for starting ESS.
807
 
* S-plus:                                System dependent.
808
 
* search() <1>:                          Completion.
809
 
* search():                              Hot keys.
810
 
* source() <1>:                          Evaluating code.
811
 
* source():                              Loading.
812
 
* STERM:                                 Is the Statistical Process running under ESS?.
813
 
* X-displays-list:                       Variables for starting ESS.
814
 
 
815