1 @node ESS(S)--Editing files, iESS(S)--Inferior ESS processes, , ESS for the S family
2 @comment node-name, next, previous, up -- don't use @ESS ..
3 @section ESS[S]--Editing files
5 @ESS{[S]} is the mode for editing S language files. This mode handles:
9 proper indenting, generated by both [Tab] and [Return].
11 color and font choices based on syntax.
13 ability to send the contents of an entire buffer, a highlighted
14 region, an S function, or a single line to an inferior S process, if
15 one is currently running.
17 ability to switch between processes which would be the target of the
18 buffer (for the above).
20 The ability to request help from an S process for variables and
21 functions, and to have the results sent into a separate buffer.
23 completion of object names and file names.
26 @ESS{[S]} mode should be automatically turned on when loading a file with
27 the suffices found in ess-site (*.R, *.S, *.s, etc). However, one
28 will have to start up an inferior process to take advantage of the
31 @node iESS(S)--Inferior ESS processes, ESS-help--assistance with viewing help, ESS(S)--Editing files, ESS for the S family
32 @comment node-name, next, previous, up
33 @section iESS[S]--Inferior ESS processes
34 iESS (inferior ESS) is the mode for interfacing with active
35 statistical processes (programs). This mode handles:
39 proper indenting, generated by both [Tab] and [Return].
41 color and font highlighting based on syntax.
43 ability to resubmit the contents of a multi-line command
44 to the executing process with a single keystroke [RET].
46 The ability to request help from the current process for variables
47 and functions, and to have the results sent into a separate buffer.
49 completion of object names and file names.
51 interactive history mechanism.
53 transcript recording and editing.
56 To start up iESS mode, use:
65 (for S-PLUS 3.x, S4, S+5, S+6 or S+7, and R, respectively. This assumes that
66 you have access to each). Usually the site will have defined one of
67 these programs (by default S+6) to the simpler name:
71 In the (rare) case that you wish to pass command line arguments to the
72 starting S+6 process, set the variable @code{inferior-Splus-args}.
74 Note that R has some extremely useful command line arguments. For
75 example, @code{--vanilla} will ensure R starts up without loading in any init
76 files. To enter a command line argument, call R using a "prefix
81 and when ESS prompts for "Starting Args ? ", enter (for example):
85 Then that R process will be started up using @code{R --vanilla}. If you
86 wish to always call R with certain arguments, set the variable
87 @code{inferior-R-args} accordingly.
89 @comment Menubar access to other versions of R and Sqpe
91 If you have other versions of R or S-Plus available on the system, ESS
92 is also able to start those versions. How this works depend on which OS
97 If you have "R-1.8.1" on
98 your `exec-path', it can be started using @kbd{M-x R-1.8.1}. By
99 default, ESS will find versions of R beginning "R-1" or "R-2". If your
100 versions of R are called other names, consider renaming them with a
101 symbolic link or change the variable @code{ess-r-versions}. To see
102 which defuns have been created for starting different versions of R,
103 type @kbd{M-x R-} and then hit [Tab]. You will then see if any defuns
104 for particular versions of R have been created. These other versions of
105 R can also be started from the "ESS->Start Process->Other" menu.
107 R on Windows systems:
108 If you have "rw1081" on
109 your `exec-path', it can be started using @kbd{M-x rw1081}. By
110 default, ESS will find versions of R located in directories
111 parallel to the version of R in your @code{PATH}. If your
112 versions of R are called other names, you will need to change the variable
113 @code{ess-rterm-versions}. To see
114 which defuns have been created for starting different versions of R,
115 type @kbd{M-x rw} and then hit [Tab]. You will then see if any defuns
116 for particular versions of R have been created. These other versions of
117 R can also be started from the "ESS->Start Process->Other" menu.
120 S on Unix systems: If you have "Splus7" on your `exec-path', it can be
121 started using @kbd{M-x Splus7}. By default, ESS will find all
122 executables beginning "Splus" on your path. If your versions of S are
123 called other names, consider renaming them with a symbolic link or
124 change the variable @code{ess-s-versions}. To see which defuns have
125 been created for starting different versions of Splus, type @kbd{M-x
126 Splus} and then hit [Tab]. You will then see if any defuns for
127 particular versions of Splus have been created. These other versions of
128 Splus can also be started from the "ESS->Start Process->Other" menu.
130 A second mechanim is also available for running other versions of Splus.
131 The variable @code{ess-s-versions-list} is a list of lists; each sublist
132 should be of the form: (DEFUN-NAME PATH ARGS). DEFUN-NAME is the name
133 of the new emacs function you wish to create to start the new S process;
134 PATH is the full path to the version of S you want to run; ARGS is an
135 optional string of command-line arguments to pass to the S process.
136 Here is an example setting:
138 (setq ess-s-versions-list
139 '( ("Splus64" "/usr/local/bin/Splus64")
140 ("Splus64-j" "/usr/local/bin/Splus64" "-j")))
142 which will then allow you to do @kbd{M-x Splus64-j} to start Splus64
143 with the corresponding command line arguments.
146 If you change the value of either @code{ess-s-versions} or
147 @code{ess-s-versions-list}, you should put them in your .emacs before
148 ess-site is loaded, since the new emacs functions are created when ESS
154 Sqpe (S-Plus running inside an emacs buffer) on Windows systems:
155 If you have an older version of S-Plus (S-Plus 6.1 for example) on your system,
156 ir can be started inside an emacs buffer with @kbd{M-x splus61}. By
157 default, ESS will find versions of S-Plus located in the installation
158 directories that Insightful uses by default. If your
159 versions of S-Plus are anywhere else, you will need to change the variable
160 @code{ess-SHOME-versions}. To see
161 which defuns have been created for starting different versions of S-Plus,
162 type @kbd{M-x spl} and then hit [Tab]. You will then see if any defuns
163 for particular versions of S-Plus have been created. These other versions of
164 S-Plus can also be started from the "ESS->Start Process->Other" menu.
167 @node ESS-help--assistance with viewing help, Philosophies for using ESS(S),iESS(S)--Inferior ESS processes,ESS for the S family
168 @comment node-name, next, previous, up
169 @section ESS-help--assistance with viewing help
171 ESS has built-in facilities for viewing help files from S. @xref{Help}.
174 @node Philosophies for using ESS(S), Scenarios for use (possibilities--based on actual usage), ESS-help--assistance with viewing help, ESS for the S family
175 @section Philosophies for using ESS[S]
177 The first is preferred, and configured for. The second one can be
178 retrieved again, by changing emacs variables.
180 1: (preferred by the current group of developers): The source code is
181 real. The objects are realizations of the source code. Source
182 for EVERY user modified object is placed in a particular directory
183 or directories, for later editing and retrieval.
185 2: (older version): S objects are real. Source code is a temporary
186 realization of the objects. Dumped buffers should not be saved.
187 _We_strongly_discourage_this_approach_. However, if you insist,
188 add the following lines to your .emacs file:
190 (setq ess-keep-dump-files 'nil)
191 (setq ess-delete-dump-files t)
192 (setq ess-mode-silently-save nil)
194 The second saves a small amount of disk space. The first allows for
195 better portability as well as external version control for code.
197 @node Scenarios for use (possibilities--based on actual usage), Customization Examples and Solutions to Problems, Philosophies for using ESS(S),ESS for the S family
198 @section Scenarios for use (possibilities--based on actual usage)
200 We present some basic suggestions for using ESS to interact with S.
201 These are just a subset of approaches, many better approaches are
202 possible. Contributions of examples of how you work with ESS are
203 appreciated (especially since it helps us determine priorities on
204 future enhancements)! (comments as to what should be happening are
207 1: ## Data Analysis Example (source code is real)
208 ## Load the file you want to work with
211 ## Edit as appropriate, and then start up S-PLUS 3.x
214 ## A new buffer *S+3:1* will appear. Splus will have been started
215 ## in this buffer. The buffer is in iESS [S+3:1] mode.
217 ## Split the screen and go back to the file editing buffer.
220 ## Send regions, lines, or the entire file contents to S-PLUS. For regions,
221 ## highlight a region with keystrokes or mouse and then send with:
224 ## Re-edit myfile.s as necessary to correct any difficulties. Add
225 ## new commands here. Send them to S by region with C-c C-r, or
226 ## one line at a time with C-c C-n.
228 ## Save the revised myfile.s with C-x C-s.
230 ## Save the entire *S+3:1* interaction buffer with C-c C-s. You
231 ## will be prompted for a file name. The recommended name is
232 ## myfile.St. With the *.St suffix, the file will come up in ESS
233 ## Transcript mode the next time it is accessed from Emacs.
237 2: ## Program revision example (source code is real)
239 ## Start up S-PLUS 3.x in a process buffer (this will be *S+3:1*)
242 ## Load the file you want to work with
245 ## edit program, functions, and code in myfile.s, and send revised
246 ## functions to S when ready with
248 ## or highlighted regions with
250 ## or individual lines with
252 ## or load the entire buffer with
255 ## save the revised myfile.s when you have finished
260 3: ## Program revision example (S object is real)
262 ## Start up S-PLUS 3.x in a process buffer (this will be *S+3:1*)
265 ## Dump an existing S object my.function into a buffer to work with
267 ## a new buffer named yourloginname.my.function.S will be created with
268 ## an editable copy of the object. The buffer is associated with the
269 ## pathname /tmp/yourloginname.my.function.S and will amlost certainly not
270 ## exist after you log off.
272 ## enter program, functions, and code into work buffer, and send
273 ## entire contents to S-PLUS when ready
276 ## Go to *S+3:1* buffer, which is the process buffer, and examine
279 ## The sequence C-c C-y is a shortcut for: C-x b *S+3:1*
281 ## Return to the work buffer (may/may not be prefixed)
282 C-x C-b yourloginname.my.function.S
283 ## Fix the function that didn't work, and resubmit by placing the
284 ## cursor somewhere in the function and
286 ## Or you could've selected a region (using the mouse, or keyboard
287 ## via setting point/mark) and
289 ## Or you could step through, line by line, using
291 ## Or just send a single line (without moving to the next) using
293 ## To fix that error in syntax for the "rchisq" command, get help
298 4: Data Analysis (S object is real)
299 ## Start up S-PLUS 3.x, in a process buffer (this will be *S+3:1*)
302 ## Work in the process buffer. When you find an object that needs
303 ## to be changed (this could be a data frame, or a variable, or a
304 ## function), dump it to a buffer:
305 C-c C-d my.cool.function
307 ## Edit the function as appropriate, and dump back in to the
311 ## Return to the S-PLUS process buffer
315 ## When you need help, use
317 ## instead of entering: help("rchisq")
321 @node Customization Examples and Solutions to Problems, , Scenarios for use (possibilities--based on actual usage),ESS for the S family
322 @section Customization Examples and Solutions to Problems
324 1. Suppose that you are primarily an SPLUS 3.4 user, occasionally
325 using S version 4, and sick and tired of the buffer-name *S+3*
326 we've stuck you with. Simply edit the "ess-dialect" alist entry in
327 the essd-sp3.el and essd-s4.el files to be "S" instead of "S4" and
328 "S+3". This will ensure that all the inferior process buffer names
331 2. Suppose that you WANT to have the first buffer name indexed by
332 ":1", in the same manner as your S-PLUS processes 2,3,4, and 5 (for
333 you heavy simulation people). Then uncomment the line in ess-site
334 (or add after your (require 'ess-site) or (load "ess-site") command
335 in your .emacs file, the line:
337 (setq ess-plain-first-buffername nil)
341 3. Fontlocking sometimes fails to behave nicely upon errors. When
342 Splus dumps, a mis-matched " (double-quote) can result in the
343 wrong font-lock face being used for the remainder of the buffer.
345 Solution: add a " at the end of the "Dumped..." statement, to
346 revert the font-lock face back to normal.