From f6e5e1f33f4fe231366944374d9d4ce36d67e317 Mon Sep 17 00:00:00 2001
From: stephen If you commonly create or modify S functions, you will have found
-the standard facilities for this (the fix() function, for
+the standard facilities for this (the `fix()' function, for
example) severely limiting. Using S's standard features, one can only
edit one function at a time, and you can't continue to use S while
editing. ESS corrects these problems by introducing the following
@@ -333,10 +337,11 @@ See Transcript resubmit.
Changes/New Features in 5.2.11:
Changes/New Features in 5.2.5:
The The to your user or system installation file (GNU Emacs uses
-$HOME/.emacs and XEmacs uses $HOME/.xemacs/init.el for the
-user initialization file. GNU Emacs uses default.el or
-site-init.el and XEmacs uses site-start.el for the system
+$HOME/.emacs and XEmacs uses $HOME/.xemacs/init.el for the
+user initialization file. GNU Emacs uses default.el or
+site-init.el and XEmacs uses site-start.el for the system
installation file).
- Alternatively, if ess-site.el is in your current Alternatively, if ess-site.el is in your current to configure emacs for ESS.
@@ -1058,8 +1068,8 @@ installation file).
If you want to place the compiled files in other locations edit the
You can compile those files by:
Extract the files from the distribution, which will unpack
-into a subdirectory, ess-VERSION.
- The Do not create ess-VERSION yourself, or you will get an extra level
-of depth to your directory structure.
+ to your emacs initialization file. (GNU Emacs uses the filename
+~/.emacs and XEmacs uses the filename
+~/.xemacs/init.el for the initialization file. The tilde is
+recognised by emacs as your HOME directory, i.e. the value of your HOME
+environment variable.) Replace
+ After saving your initialization file, ESS is now installed. Start a
+new emacs and you should be ready to use ESS. For example, to edit
+statistical programs, load the files with the requisite extensions
+(".sas" for SAS, ".S" or "s" or "q" or "Q" for S-PLUS, ".r" or ".R" for
+R, and ".lsp" for XLispStat). One further step is needed if you wish to
+run statistical processes, see below.
+
+ On Windows NT/2000/XP, add the directories to the PATH using the
@@ -1185,22 +1194,13 @@ for each software program. Be sure to use the abbreviation
An alternative, for R users, is that rather than adjusting the PATH
+variable, you can add the following to your emacs initialization file
+(and restart emacs):
+ to your .emacs (or _emacs) file (or default.el or site-init.el, for
-a site-wide installation). Replace This assumes that you have installed R-2.2.1 in the default location.
+Change the path otherwise to point to other locations.
To start the S-PLUS [67].x GUI from ESS under emacs:
Enter the name of the directory you wish to start S from (that is,
the directory you would have You will then be popped into a buffer
-with name *S* which will be used
+with name `*S*' which will be used
for interacting with the ESS process, and you can start entering commands.
ESS allows you to run more than one ESS process simultaneously in the
same session. Each process has a name and a number; the initial process
-(process 1) is simply named (using S-PLUS as an example) S+3:1.
+(process 1) is simply named (using S-PLUS as an example) `S+3:1'.
The name of the process is shown in the mode line in square brackets
-(for example, [S+3:2]); this is useful if the process buffer is
+(for example, `[S+3:2]'); this is useful if the process buffer is
renamed. Without a prefix argument, M-x S starts a new ESS
process, using the first available process number. With a prefix
argument (for R), C-u M-x R allows for the specification of
command line options.
You can switch to any active ESS process with the command
-M-x ess-request-a-process. Just enter the name of the process
+`M-x ess-request-a-process'. Just enter the name of the process
you require; completion is provided over the names of all running S
processes. This is a good command to consider binding to a global key.
@@ -1452,10 +1456,11 @@ processes. This is a good command to consider binding to a global key.
Should you or a colleague inadvertently start a statistical process in
-an ordinary *shell* buffer, the ess-remote command can
+an ordinary `*shell*' buffer, the `ess-remote' command can
be used to convert it to an ESS buffer and allow you to use the ESS
commands with it.
@@ -1523,62 +1528,64 @@ See S+elsewhere and ESS-elsewhe
These commands are now deprecated. We recommend ess-remote. We
-have two versions of the elsewhere function. S+elsewhere is
+ These commands are now deprecated. We recommend `ess-remote'. We
+have two versions of the elsewhere function. `S+elsewhere' is
specific for the S-Plus program. The more general function
-ESS-elsewhere is not as stable.
+`ESS-elsewhere' is not as stable.
Or enter M-x ESS-elsewhere. You will be prompted for an ESS
+ Or enter `M-x ESS-elsewhere'. You will be prompted for an ESS
program and for a starting directory. I usually give it my project
-directory on the local machine, say ~myname/myproject/
+directory on the local machine, say `~myname/myproject/'
- Enter the name of a file in which to save the transcript at the prompt.
If the file doesn't exist it will be created (and you should give it a
-file name ending in .St); if the file already exists the
+file name ending in `.St'); if the file already exists the
transcript will be appended to the file. (Note: if you don't set this
variable but you still want to save the transcript, you can still do it
later — see Saving transcripts.)
@@ -1628,7 +1636,7 @@ in the variable By default, the new process will be displayed in the same window in the
@@ -1640,10 +1648,11 @@ process to appear within another window of the current frame.
If you make a typing error before pressing RET all the usual Emacs
-editing commands are available to correct it (see Basic (The GNU Emacs Reference Manual)). Once the
+editing commands are available to correct it (see Basic). Once the
command has been corrected you can press <RETURN> (even if the
cursor is not at the end of the line) to send the corrected command to
the ESS process.
@@ -1712,16 +1723,17 @@ command you have not yet sent to the ESS process.
prompt, if any.
See Shell Mode (The Gnu Emacs Reference Manual), for other
+ See Shell Mode, for other
commands relevant to entering input.
For example, consider the three functions (available in Splus version
3.0) called ESS also provides completion over the components of named lists accessed
-using the $ notation, to any level of nested lists. This feature
+using the `$' notation, to any level of nested lists. This feature
is particularly useful for checking what components of a list object
exist while partway through entering a command: simply type the object
-name and $ and press TAB to see the names of existing list
+name and `$' and press TAB to see the names of existing list
components for that object.
Completion is also provided over file names, which is particularly
useful when using S functions such as If the cursor is not in a string and does not follow a (partial) object
name, the <TAB> key has a third use: it expands history references.
@@ -1786,10 +1798,11 @@ See History expansion.
If an ESS process finishes and you restart it in the same process
buffer, the output from the new ESS process appears after the output
-from the first ESS process separated by a form-feed (^L)
+from the first ESS process separated by a form-feed (`^L')
character. Thus pages in the ESS
process buffer correspond to ESS sessions. Thus, for example, you may
use C-x [ and C-x ] to move backward and forwards through
ESS sessions in a single ESS process buffer. For more information about
-page commands, see Pages (The GNU Emacs Reference Manual).
+page commands, see Pages.
Completion is provided in the edit buffer in a similar fashion to the
process buffer: M-TAB completes file names and M-? lists
@@ -3225,10 +3272,11 @@ for more details on these commands.
A safer option is to set ESS: Emacs Speaks Statistics
@@ -170,10 +172,11 @@ statements written in these statistical analysis languages.
1 Introduction to ESS
@@ -238,10 +241,11 @@ your S functions in specified source directories.
1.1 Why should I use ESS?
@@ -260,14 +264,14 @@ package which is waiting for you to input commands). These include:
1.2 New features in ESS
@@ -354,7 +359,7 @@ define 'baseenv' where needed.
-
ess-sas-file-root
for details; all lag
and dif
functions now fontified correctly
@@ -372,12 +377,12 @@ Splus you would like to run.
customization was not taking effect unless customizations were loaded
before ESS). Its value has been changed so that it will also find R
executables beginning “R-devel” and “R-patched”. If you wish to
-change this variable, it must be set in your .emacs before ESS is
+change this variable, it must be set in your .emacs before ESS is
loaded.
make install
-
- (ess-cleanup)
, called from
ess-quit, now depends on the new customizable variable
ess-S-quit-kill-buffers-p
which defaults to nil
.
@@ -463,7 +468,7 @@ with the recode
application as well which is available on many plat
1.3 Authors of and contributors to ESS
@@ -867,10 +873,11 @@ S-mode and ESS mailing lists.
1.4 Getting the latest version of ESS
@@ -915,9 +922,10 @@ certificate permanently and will not be asked about it anymore.
1.5 How to read this manual
@@ -969,10 +977,11 @@ defer this section until you are more familiar with ESS.
2 Installing ESS on your system
@@ -999,9 +1008,10 @@ See Microsoft Windows installation
-Next: Microsoft Windows installation,
+
+Next: Microsoft Windows installation,
Up: Installation
-
+
cd
to a directory where you want to install ESS, creating it if necessary.
-This directory will be referred to below as ESSDIR.
+This directory will be referred to below as ESSDIR.
@@ -1019,13 +1029,13 @@ This directory will be referred to below as ESSDIR.
Either,
- gunzip < ess-VERSION.tar.gz | tar xf -
,
or using GNU tar, tar zxf ess-VERSION.tar.gz
.
tar
command will create the subdirectory ess-VERSION and install
+ tar
command will create the subdirectory ess-VERSION and install
the files there.
@@ -1034,7 +1044,7 @@ the files there.
- (load "ESSDIR/ess-VERSION/lisp/ess-site")
load-path
, then:
+ load-path
, then:
(require 'ess-site)
M-x R
.
@@ -1087,8 +1097,8 @@ process within emacs, such as R, type M-x R
.
LISPDIR
, INFODIR
and ETCDIR
entries in Section 1 of
-Makeconf in the ESSDIR/ess-VERSION directory (if you are
-using XEmacs, then see the XEmacs subsection in Section 1 of Makeconf).
+Makeconf in the ESSDIR/ess-VERSION directory (if you are
+using XEmacs, then see the XEmacs subsection in Section 1 of Makeconf).
make all
@@ -1119,10 +1129,11 @@ has been installed. For more information on installing XEmacs packages, see
@@ -1133,48 +1144,46 @@ Up: Installation
-
cd
to a directory where you keep emacs lisp files, or create a new
-directory (for example, c:\emacs\) to hold the distribution. This
-directory will be referred to below as "the ESS distribution
-directory". It will contain, at the end, either the tar file
-ess-VERSION.tar.gz or the zip file ess-VERSION.zip, and a
-directory
-for the ESS source, which will be termed "the ESS-VERSION source
-directory".
-
- cd c:\emacs
-
- gunzip ess-VERSION.tar.gz
- tar xf ess-VERSION.tar
- (or:
- gunzip < ess-VERSION.tar.gz | tar xf -
).
- (or: from the zip file: unzip ess-VERSION.zip
)
- tar
command will extract files into the current directory.
+ cd
to a directory where you keep emacs lisp files, or create a
+new directory (for example, c:\emacs\) to hold the distribution.
+This directory will be referred to below as "the ESS distribution
+directory". It will contain, at the end, a directory for the ESS
+source, which will be termed "the ESS-VERSION source directory".
- (load "C:/emacs/ess-VERSION/lisp/ess-site")
+
+ VERSION
above with the version number of ESS. Remember to use
+forwardslashes /
rather than \\
in your filename.
+
+ path=%PATH%;c:\progra~1\spls2000\cmd
progra~1
and not the long version with embedded blanks. Use
backslashes "\".
- (load "/PATH/ess-site")
+
(setq inferior-R-program-name "C:/progra~1/R/R-2.2.1/bin/Rterm.exe")
- /PATH
above with the
-value of ess-lisp-directory as defined in ess-site.el. Use
-forwardslashes /
.
-(GNU Emacs uses the filename %HOME%/.emacs and
-XEmacs uses the filename %HOME%/.xemacs/init.el
-for the initialization file.)
-
- M-x S
@@ -1214,7 +1214,7 @@ slight delay during which emacs is temporarily frozen. ESS will arrange for
communication with the S-PLUS GUI using the DDE protocol.
Send lines or regions
from the emacs buffer containing your S program (for example,
-myfile.s) to the S-PLUS Commands Window with the
+myfile.s) to the S-PLUS Commands Window with the
C-c C-n
or C-c C-r
keys.
(If you are still using S-PLUS 4.x or 2000, then use M-x S+4
.)
@@ -1229,7 +1229,7 @@ propose your current directory as the default.
You get Unix-like behavior, in particular the entire
transcript is available for emacs-style search commands.
Send lines or regions from the emacs buffer containing your S
-program (for example, myfile.s) to the *S+6* buffer with the
+program (for example, myfile.s) to the *S+6* buffer with the
C-c C-n
or C-c C-r
keys.
Interactive graphics are available with Sqpe by using the java
library supplied with S-PLUS 6.1 and newer releases.
@@ -1254,7 +1254,7 @@ as the default. ESS will arrange for
communication with the already running S-PLUS GUI using the DDE protocol.
Send lines or regions
from the emacs buffer containing your S program (for example,
-myfile.s) to the S-PLUS Commands Window with the
+myfile.s) to the S-PLUS Commands Window with the
C-c C-n
or C-c C-r
keys.
(If you are still using S-PLUS 4.x or 2000, then use M-x S+4-existing
.)
@@ -1313,9 +1313,10 @@ emacs, and cut and paste the results into the XLispStat
-Previous: Microsoft Windows installation,
+
+Previous: Microsoft Windows installation,
Up: Installation
-
+
3 Interacting with statistical programs
@@ -1388,10 +1390,11 @@ with statistical programs.
-Next: Multiple ESS processes,
+
+Next: Multiple ESS processes,
Previous: Interactive ESS,
Up: Interactive ESS
-
+
3.1 Starting an ESS process
@@ -1405,19 +1408,20 @@ S will then (by default) ask the question
cd
'd to before starting S from
-the shell). This directory should have a .Data subdirectory.
+the shell). This directory should have a .Data subdirectory.
-Next: ESS processes on Remote Computers,
+
+Next: ESS processes on Remote Computers,
Previous: Starting up,
Up: Interactive ESS
-
+
3.2 Running more than one ESS process
@@ -1425,20 +1429,20 @@ Up: Interactive ESS
-Next: S+elsewhere and ESS-elsewhere,
+
+Next: S+elsewhere and ESS-elsewhere,
Previous: Multiple ESS processes,
Up: Interactive ESS
-
+
3.3 ESS processes on Remote Computers
@@ -1468,20 +1473,20 @@ ssh buffer and then connect ESS to that buffer.
-Next: Customizing startup,
+
+
+Next: Customizing startup,
Previous: ESS processes on Remote Computers,
Up: Interactive ESS
-
+
3.4 S+elsewhere and ESS-elsewhere
-
-
@@ -1586,9 +1593,10 @@ display it with ghostscript.
-Previous: S+elsewhere and ESS-elsewhere,
+
+Previous: S+elsewhere and ESS-elsewhere,
Up: Interactive ESS
-
+
3.5 Changing the startup actions
@@ -1615,7 +1623,7 @@ transcript.
inferior-
S_program_name-args
inferior-ess-program is "S+"
then the variable to set is
inferior-S+-args
.
It is not normally necessary to pass arguments to the S program; in
-particular do not pass the -e option to Splus
, since ESS
+particular do not pass the `-e' option to Splus
, since ESS
provides its own command history mechanism.
4 Interacting with the ESS process
@@ -1654,7 +1663,7 @@ front end to the S interpreter. This is achieved by running the S
process from within an Emacs buffer, so that the Emacs editing commands
are available to correct mistakes in commands, etc. The features of
Inferior S mode are similar to those provided by the standard Emacs
-shell mode (see Shell Mode (The Gnu Emacs Reference Manual)). Command-line completion of S objects and a number of `hot
+shell mode (see Shell Mode). Command-line completion of S objects and a number of `hot
keys' for commonly-used S commands are also provided for ease of
typing.
@@ -1674,10 +1683,12 @@ typing.
4.1 Entering commands and fixing mistakes
@@ -1692,7 +1703,7 @@ and pressing the <RETURN> key:
-Next: Completion details,
+
+Next: Completion details,
Previous: Command-line editing,
Up: Entering commands
-
+
4.2 Completion of object names
@@ -1752,10 +1764,10 @@ command
binomplot()
, binom.test()
and
binomial()
. Typing bin TAB after the S prompt will
-insert the characters om, completing the longest prefix
-(binom) which distinguishes these three commands. Pressing
+insert the characters `om', completing the longest prefix
+(`binom') which distinguishes these three commands. Pressing
TAB once more provides a list of the three commands which have
-this prefix, allowing you to add more characters (say, .) which
+this prefix, allowing you to add more characters (say, `.') which
specify the function you desire. After entering more characters
pressing TAB yet again will complete the object name up to
uniqueness, etc. If you just wish to see what completions exist without
@@ -1767,17 +1779,17 @@ adding any extra characters, type M-?.
get()
or scan()
which require fully expanded file names. Whenever the cursor is within
an S string, pressing TAB completes the file name before
-point, and also expands any ~ or environment variable references.
+point, and also expands any `~' or environment variable references.
4.3 Completion details
@@ -1830,10 +1843,11 @@ problem.
-Next: Command History,
+
+Next: Command History,
Previous: Completion details,
Up: Entering commands
-
+
4.4 Manipulating the transcript
@@ -1852,16 +1866,16 @@ forwards, respectively, through commands in the transcript. A
particularly useful command is M-h (mark-paragraph
) which
will allow you to mark a command and its entire output (for deletion,
perhaps). For more information about paragraph commands,
-see Paragraphs (The GNU Emacs Reference Manual).
+see Paragraphs.
-Next: Source Directories,
+
+Next: Source Directories,
Previous: Other edit buffer commands,
Up: Editing
-
+
7.7 Maintaining S source files
@@ -3277,9 +3325,9 @@ that.
never deleted after they are loaded. Thus you can maintain a complete
text record of the functions you have edited within ESS. Backup files
are kept as usual, and so by using the Emacs numbered backup facility —
-see Single or Numbered Backups (The Gnu Emacs Reference Manual), you can keep a historic
+see Single or Numbered Backups, you can keep a historic
record of function definitions. Another possibility is to maintain the
-files with a version-control system such as RCS See Version Control (The Gnu Emacs Reference Manual). As long as a dump file exists in the appropriate place for a
+files with a version-control system such as RCS See Version Control. As long as a dump file exists in the appropriate place for a
particular object, editing that object with C-c C-d finds that
file for editing (unless a prefix argument is given) — the ESS
process is not consulted. Thus you can keep comments outside the
@@ -3296,7 +3344,7 @@ to any other file you load (say, a source file of function
definitions), and so can be dangerous to use unless you are careful.
Note that since ess-keep-dump-files
is buffer-local, you can make
sure particular files are not deleted by setting it to t
in the
-Local Variables section of the file See Local Variables in Files (The Gnu Emacs Reference Manual).
+Local Variables section of the file See Local Variables in Files.
ess-keep-dump-files
to ask
; this
means that ESS will always ask for confirmation before deleting the
@@ -3319,9 +3367,10 @@ if you happen to quit Emacs before correcting the error.
7.8 Names and locations of dump files
@@ -3335,11 +3384,11 @@ object name with some additions.
object name.
By default, dump file names are the user name, followed by . and
-the object and ending with .S. Thus if user joe
dumps the
-object myfun
the dump file will have name joe.myfun.S.
+
By default, dump file names are the user name, followed by `.' and
+the object and ending with `.S'. Thus if user joe
dumps the
+object myfun
the dump file will have name joe.myfun.S.
The username part is included to avoid clashes when dumping into a
-publicly-writable directory, such as /tmp; you may wish to remove
+publicly-writable directory, such as /tmp; you may wish to remove
this part if you are dumping into a directory owned by you.
You may also specify the directory in which dump files are written: @@ -3349,12 +3398,12 @@ this part if you are dumping into a directory owned by you.
-Directory name (ending in a slash) where S dump files are to be written.
By default, dump files are always written to /tmp, which is fine +
By default, dump files are always written to /tmp, which is fine
when ess-keep-dump-files
is nil
. If you are keeping dump
files, then you will probably want to keep them somewhere in your home
-directory, say ~/S-source. This could be achieved by including
-the following line in your .emacs file:
-
+directory, say ~/S-source. This could be achieved by including
+the following line in your .emacs file:
+
(setq ess-source-directory (expand-file-name "~/S-source/"))
If you would prefer to keep your dump files in separate directories @@ -3365,7 +3414,7 @@ flexibility in selecting the directory for a particular source file to appear in. The lambda expression is evaluated with the process buffer as the current buffer and so you can use the variables local to that buffer to make your choice. For example, the following expression -causes source files to be saved in the subdirectory Src of the +causes source files to be saved in the subdirectory Src of the directory the ESS process was run in.
(setq ess-source-directory @@ -3397,10 +3446,11 @@ be able to edit functions.8 Editing R documentation files
@@ -3412,14 +3462,14 @@ processed into a variety of formats, including LaTeX, HTML, and plain text. Rd format is described in section “Rd format” of the “Writing R Extensions” manual in the R distribution. -Visiting an Rd file as characterized by its extension Rd will +
Visiting an Rd file as characterized by its extension Rd will activate Rd Mode, which provides several facilities for making editing R documentation files more convenient, by helping with indentation, insertions, even doing some of the typing for you (with Abbrev Mode), and by showing Rd keywords, strings, etc. in different faces (with Font Lock Mode). -
Note that R also accepts Rd files with extension rd; to activate +
Note that R also accepts Rd files with extension rd; to activate ESS[Rd] support for this extension, you may need to add
(add-to-list 'auto-mode-alist '("\\.rd\\'" . Rd-mode)) @@ -3454,7 +3504,7 @@ currently, not all of the Rd text markup as described in section “Marking text” of “Writing R Extensions” can be accessed via C-c C-f. -
Rd-mode-insert-item
).
Rd-indent-level
Rd-to-help-command
To automatically turn on the abbrev and font-lock features of Rd mode, @@ -3494,10 +3544,11 @@ add the following lines to one of your Emacs startup files:
Miscellaneous:
@@ -3633,10 +3684,11 @@ variable ess-help-own-frame
.
ESS[SAS] was designed to aid the user in writing and maintaining SAS -programs, such as foo.sas. Both interactive and batch +programs, such as foo.sas. Both interactive and batch submission of SAS programs is supported.
ESS[SAS] was written with two primary goals. @@ -3689,10 +3743,12 @@ advanced ESS[SAS] users.
ESS[SAS] is automatically turned on when editing a file with a .sas +
ESS[SAS] is automatically turned on when editing a file with a .sas
suffix (or other extension, if specified via At this writing, the indenting and syntax highlighting are generally
correct. Known issues: for multiple line ESS provides an alternate behavior for <TAB> that makes it behave
@@ -3754,7 +3812,7 @@ as it does in SAS Display Manager, i.e. move the
The alternate behavior also provides a "TAB" backwards, C-<TAB>, that
moves the cursor to the stop to the left and deletes any characters
between them. This functionality is obtained by uncommenting the
-following line in ess-site.el:
+following line in ess-site.el:
Under the alternate behavior, <TAB> is bound to M-x tab-to-tab-stop
@@ -3763,10 +3821,12 @@ and the stops are defined by The command line is also made of For example, The job runs in the *shell* buffer while you continue to edit
-foo.sas. If The job runs in the *shell* buffer while you continue to edit
+foo.sas. If Terminating a SAS batch in the *shell* buffer.
+ Terminating a SAS batch in the *shell* buffer.
You may want to visit the .log (whether the job is still running
-or it is finished) and check for error messages. The .log will be
+ You may want to visit the .log (whether the job is still running
+or it is finished) and check for error messages. The .log will be
refreshed and you will be placed in it's buffer. You will be
taken to the first error message, if any.
Goto the next error message, if any.
Now, refresh the .lst and go to it's buffer.
+ Now, `refresh' the .lst and go to it's buffer.
If you wish to make changes, go to the .sas file with.
+ If you wish to make changes, go to the .sas file with.
Make your editing changes and submit again.
@@ -3878,10 +3938,12 @@ taken to the first error message, if any.
The distinction between local and global is subtle. If you want the
-ESS[SAS] definitions to work when you are in the *shell* buffer or when
+ESS[SAS] definitions to work when you are in the *shell* buffer or when
editing files other than the file extensions that ESS[SAS] recognizes,
you will most likely want to use the global definitions. If you want
your function keys to understand SAS batch commands when you are editing
@@ -3921,7 +3983,7 @@ person installing ESS for a site or by an individual.
shell switches you to the *shell* buffer where you can
+ `shell' switches you to the *shell* buffer where you can
interact with your operating system. This is especially helpful if you
would like to kill a SAS batch job. You can specify a different buffer
-name to associate with a SAS batch job (besides *shell*) with the
+name to associate with a SAS batch job (besides *shell*) with the
buffer-local variable <F2> performs the refresh operation on the current buffer.
-refresh compares the buffer's last modified date/time with the
+ <F2> performs the `refresh' operation on the current buffer.
+`refresh' compares the buffer's last modified date/time with the
file's last modified date/time and replaces the buffer with the file if the
file is newer. This is the same operation that is automatically performed
-when filetype-1 switches you to a file with the same file name as your .sas
-file, but with a different extension (.txt by default) and performs
-refresh. You can over-ride the default extension; for example in your
-~/.emacs or ~/.xemacs/init.el file:
+ `filetype-1' switches you to a file with the same file name as your .sas
+file, but with a different extension (.txt by default) and performs
+`refresh'. You can over-ride the default extension; for example in your
+~/.emacs or ~/.xemacs/init.el file:
<F9> will prompt you for the name of a permanent SAS dataset near
@@ -4048,7 +4110,7 @@ For controlling the SAS batch commands, you have
Similarly, C-<F9> will prompt you for the name of a permanent
@@ -4059,17 +4121,17 @@ commands, you have the global variables <F10> toggles ESS[SAS] mode for .log files which is off by default
+ <F10> toggles ESS[SAS] mode for .log files which is off by default
(technically, it is <F11> is the same as filetype-1 except it is .dat by default.
+ <F11> is the same as `filetype-1' except it is .dat by default.
- <F12> will prompt you for the name of a <F12> will prompt you for the name of a To start up iESS[SAS] mode, use:
The *SAS:1.log* buffer in The *SAS:1.log* buffer in The *SAS:1.lst* buffer in The *SAS:1.lst* buffer in The *SAS:1* buffer exists solely as a communications buffer.
+ The *SAS:1* buffer exists solely as a communications buffer.
The user should never use this buffer directly.
-Files are edited in the foo.sas buffer. The C-c C-r key in
+Files are edited in the foo.sas buffer. The C-c C-r key in
ESS[SAS] is the functional equivalent of bringing a file into the
-SAS: PROGRAM EDITOR window followed by For example, open the file you want to work with.
foo.sas will be in ESS[SAS] mode. Edit as appropriate, and then start
-up SAS with the cursor in the foo.sas buffer.
+ foo.sas will be in ESS[SAS] mode. Edit as appropriate, and then start
+up SAS with the cursor in the foo.sas buffer.
Four buffers will appear on screen:
Send regions, lines, or the entire file contents to SAS
(regions are most useful: a highlighted region will normally
@@ -4162,34 +4226,36 @@ begin with the keywords Information appears in the log buffer, analysis results in the
listing buffer. In case of errors, make the corrections in the
-foo.sas buffer and resubmit with another C-c C-r.
+foo.sas buffer and resubmit with another C-c C-r.
At the end of the session you may save the log and listing
buffers with the usual C-x C-s commands. You will be prompted
-for a file name. Typically, the names foo.log and foo.lst
+for a file name. Typically, the names foo.log and foo.lst
will be used. You will almost certainly want to edit the saved
files before including them in a report. The files are
read-only by default. You can make them writable by the emacs
command C-x C-q.
- At the end of the session, the input file foo.sas will
+ At the end of the session, the input file foo.sas will
typically have been revised. You can save it. It can be used
later as the beginning of another iESS[SAS] session. It can
also be used as a batch input file to SAS.
- The *SAS:1* buffer is strictly for ESS use. The user should
-never need to read it or write to it. Refer to the .lst and
-.log buffers for monitoring output!
+ The *SAS:1* buffer is strictly for ESS use. The user should
+never need to read it or write to it. Refer to the .lst and
+.log buffers for monitoring output!
Troubleshooting: See iESS(SAS)–Common problems.
ESS provides Font-Lock (see Using Multiple Typefaces (The Gnu Emacs Reference Manual)) patterns for Inferior S Mode, S
+ ESS provides Font-Lock (see Using Multiple Typefaces) patterns for Inferior S Mode, S
Mode, and S Transcript Mode buffers.
To activate highlighting, you need to turn on Font Lock mode in the
@@ -4468,7 +4547,7 @@ appropriate buffers. This can be done on a per-buffer basis with
M-x font-lock-mode, or may be done by adding
The font-lock patterns are defined in three variables, which you may
@@ -4478,7 +4557,7 @@ modify if desired:
— Variable: inferior-ess-font-lock-keywords Font-lock patterns for Inferior ESS Mode. The default value
highlights prompts, inputs, assignments, output messages, vector and
-matrix labels, and literals such as NA and
ESS can be easily customized to your taste simply by including the
-appropriate lines in your .emacs file. There are numerous
+appropriate lines in your .emacs file. There are numerous
variables which affect the behavior of ESS in certain situations which
can be modified to your liking. Keybindings may be set or changed to
your preferences, and for per-buffer customizations hooks are also
@@ -4865,10 +4959,11 @@ to make it easy to find related variables.
auto-mode-alist
). The function
keys can be enabled to use the same function keys that
the SAS Display Manager does. The interactive capabilities of ESS require you
@@ -3724,7 +3780,7 @@ to start an inferior SAS process with M-x&nb
*
or %*
comments, only the
-first line is highlighted; for .log files, only the first line of a
+first line is highlighted; for .log files, only the first line of a
NOTE:
, WARNING:
or ERROR:
message is highlighted; unmatched
single/double quotes in CARDS
data lines are NOT ignored; in an
iterative DO
statement, TO
and BY
are not highlighted.
@@ -3732,10 +3788,12 @@ iterative DO
statement, TO
and BY
are not
-Next: ESS(SAS)--Batch SAS processes,
+
+
+Next: ESS(SAS)--Batch SAS processes,
Previous: ESS(SAS)--Editing files,
Up: ESS for SAS
-
+
10.3 ESS(SAS)–<TAB> key
@@ -3746,7 +3804,7 @@ the left margin, other statements are indented sas-indent-width
spa
continuation lines are indented sas-indent-width
spaces in from the beginning column of
that statement. This is the type of functionality that emacs provides
in most programming language modes. This functionality is equivalent to
-uncommenting the following line in ess-site.el:
+uncommenting the following line in ess-site.el:
(setq ess-sas-edit-keys-toggle nil)
(setq ess-sas-edit-keys-toggle t)
ess-sas-tab-stop-list
.
-Next: ESS(SAS)--Function keys for batch processing,
+
+
+Next: ESS(SAS)--Function keys for batch processing,
Previous: ESS(SAS)--TAB key,
Up: ESS for SAS
-
+
10.4 ESS(SAS)–Batch SAS processes
@@ -3793,7 +3853,7 @@ locally before remotely logging in. Open a local copy of the file with the
ess-kermit-prefix
character prepended (the default is "#"
).
Execute the command M-x ess-kermit-get which automatically brings
the contents of the remote file into your local copy. If you transfer
-files with Kermit manually in a *shell* buffer, then note that the
+files with Kermit manually in a *shell* buffer, then note that the
Kermit escape sequence is C-q C- c rather than C- c which
it would be in an ordinary terminal application, i.e. not in an emacs
buffer. Lastly, note that the remote Kermit command is specified by
@@ -3814,7 +3874,7 @@ buffer-local. Conveniently, it can be set at the end of the program:
ess-sas-submit-pre-command
,
ess-sas-submit-post-command
and ess-sas-submit-command-options
(the last of which is also buffer-local).
-Here are some examples for your ~/.emacs or ~/.xemacs/init.el
+Here are some examples for your ~/.emacs or ~/.xemacs/init.el
file (you may also use M-x customize-variable):
;'sh default
(setq ess-sas-submit-pre-command "nohup")
@@ -3836,29 +3896,29 @@ a UNIX-imitating shell under Windows. This is necessary in m
since the shell might not be ready to receive a command. This delay is
currently set high enough so as not to be a problem. But, there may be
cases when it needs to be set higher, or could be set much lower to
-speed things up. You can over-ride the default in your ~/.emacs or ~/.xemacs/init.el file by:
+speed things up. You can over-ride the default in your ~/.emacs or ~/.xemacs/init.el file by:
(setq ess-sleep-for 0.2)
(setq ess-sas-global-unix-keys t)
keys shown,
(setq ess-sas-global-pc-keys t)
in parentheses;
ESS[SAS] function keys are presented in the next section.
Open the file you want to work with C-x C-f foo.sas.
-foo.sas will be in ESS[SAS] mode. Edit as appropriate, then save and
+foo.sas will be in ESS[SAS] mode. Edit as appropriate, then save and
submit the batch SAS job.
<F3> (<F8>)
- ess-sas-submit-method
is 'sh
, then the
+ ess-sas-submit-method
is 'sh
, then the
message buffer will display the shell notification when the
job is complete. The 'sh
setting also allows you to
terminate the SAS batch job before it is finished.
<F8> (<F3>)
- kill PID
- <F5> (<F6>)
@@ -3866,10 +3926,10 @@ taken to the first error message, if any.
<F5> (<F6>)
- <F6> (<F7>)
- <F4> (<F5>)
-Next: iESS(SAS)--Interactive SAS processes,
+
+
+Next: iESS(SAS)--Interactive SAS processes,
Previous: ESS(SAS)--Batch SAS processes,
Up: ESS for SAS
-
+
10.5 ESS(SAS)–Function keys for batch processing
@@ -3911,7 +3973,7 @@ are associated with ESS[SAS] as specified in your auto-
;;2; (setq ess-sas-local-unix-keys t)
@@ -3945,45 +4007,45 @@ some of the nicknames as SAS Display Manager comm
capitals).
@@ -4020,25 +4082,25 @@ explanation since they mimic the SAS Display Mana
related function key definitions. However, six other keys have been
provided for convenience and are described below.
- UNIX PC Nickname
- <F2> <F2> refresh
+ <F2> <F2> `refresh'
revert the current buffer with the file of the same
name if the file is newer than the buffer
<F3> <F8> SUBMIT
- save the current .sas file (which is either the .sas
- file in the current buffer or the .sas file associated
- with the .lst or .log file in the current buffer)
+ save the current .sas file (which is either the .sas
+ file in the current buffer or the .sas file associated
+ with the .lst or .log file in the current buffer)
and submit the file as a batch SAS job
<F4> <F5> PROGRAM
- switch buffer to .sas file
+ switch buffer to .sas file
<F5> <F6> LOG
- switch buffer to .log file, refresh and goto next
+ switch buffer to .log file, `refresh' and goto next
error message, if any
<F6> <F7> OUTPUT
- switch buffer to .lst file and refresh
- <F7> <F4> filetype-1
+ switch buffer to .lst file and `refresh'
+ <F7> <F4> `filetype-1'
- switch buffer to filetype-1 (defaults to .txt) file
- and refresh
- <F8> <F3> shell
+ switch buffer to `filetype-1' (defaults to .txt) file
+ and `refresh'
+ <F8> <F3> `shell'
- switch buffer to *shell*
+ switch buffer to *shell*
<F9> <F9> VIEWTABLE
open an interactive PROC FSEDIT
session on the SAS
dataset near point
<F10> <F10> toggle-log
- toggle ESS[SAS] for .log files; useful for certain
+ toggle ESS[SAS] for .log files; useful for certain
debugging situations
- <F11> <F11> filetype-2
+ <F11> <F11> `filetype-2'
- switch buffer to filetype-2 (defaults to .dat) file
- and refresh
+ switch buffer to `filetype-2' (defaults to .dat) file
+ and `refresh'
<F12> <F12> viewgraph
open a GSASFILE
near point for viewing either in emacs
@@ -3991,27 +4053,27 @@ capitals).
C-<F1> C-<F1> rtf-portrait
create an MS RTF portrait file from the current buffer
- with a file extension of .rtf
+ with a file extension of .rtf
C-<F2> C-<F2> rtf-landscape
create an MS RTF landscape file from the current buffer
- with a file extension of .rtf
+ with a file extension of .rtf
C-<F3> C-<F8> submit-region
- write region to ess-temp.sas and submit
+ write region to ess-temp.sas and submit
C-<F5> C-<F6> append-to-log
- append ess-temp.log to the current .log file
+ append ess-temp.log to the current .log file
C-<F6> C-<F7> append-to-output
- append ess-temp.lst to the current .lst file
+ append ess-temp.lst to the current .lst file
C-<F9> C-<F9> INSIGHT
open an interactive PROC INSIGHT
session on the SAS
dataset near point
C-<F10> C-<F10> toggle-listing
- toggle ESS[SAS] for .lst files; useful for toggling
+ toggle ESS[SAS] for .lst files; useful for toggling
read-only
ess-sas-shell-buffer
. This allows you to have
multiple buffers running SAS batch jobs on multiple local/remote
computers that may rely on different methods specified by the buffer-local
variable ess-sas-submit-method
.
- LOG
, OUTPUT
, filetype-1 or <F11> are pressed.
+when LOG
, OUTPUT
, `filetype-1' or <F11> are pressed.
- (setq ess-sas-suffix-1 "csv") ; for example
ess-sas-data-view-libname
and
ess-sas-data-view-fsview-command
as well as the buffer-local
variable ess-sas-data-view-fsview-statement
. If you have your
-SAS LIBNAME
defined in ~/autoexec.sas, then the defaults
+SAS LIBNAME
defined in ~/autoexec.sas, then the defaults
for these variables should be sufficient.
ess-sas-data-view-libname
and ess-sas-data-view-insight-command
as well as the buffer-local
variable ess-sas-data-view-insight-statement
.
- SAS-log-mode
, but it looks the same). The syntax
highlighting can be helpful in certain debugging situations, but large
-.log files may take a long time to highlight.
+.log files may take a long time to highlight.
- GSASFILE
near the point in .log to
+ GSASFILE
near the point in .log to
be opened for viewing either with emacs or with an external viewer.
Depending on your version of emacs and the operating system you are
-using, emacs may support .gif and .jpg files internally. You may need
+using, emacs may support .gif and .jpg files internally. You may need
to change the following variables for your own situation.
ess-sas-graph-view-suffix-regexp
is a regular expression of supported
file types defined via file name extensions.
@@ -4093,10 +4155,12 @@ landscape (first line for "global" key mapping, second for "local"):
-Next: iESS(SAS)--Common problems,
+
+
+Next: iESS(SAS)--Common problems,
Previous: ESS(SAS)--Function keys for batch processing,
Up: ESS for SAS
-
+
10.6 iESS(SAS)–Interactive SAS processes
@@ -4120,40 +4184,40 @@ with the SAS command-line option settings
M-x SAS
- ESStr
mode corresponds to the file
-foo.log in SAS batch usage and to the SAS: LOG window in the
+ ESStr
mode corresponds to the file
+foo.log in SAS batch usage and to the `SAS: LOG' window in the
SAS Display Manager. All commands submitted to SAS, informative
messages, warnings, and errors appear here.
- ESSlst
mode corresponds to the file
-foo.lst in SAS batch usage and to the SAS: OUTPUT window in the
+ ESSlst
mode corresponds to the file
+foo.lst in SAS batch usage and to the `SAS: OUTPUT' window in the
SAS Display Manager. All printed output appears in this window.
- SUBMIT
.
+`SAS: PROGRAM EDITOR' window followed by SUBMIT
.
C-x C-f foo.sas
- M-x SAS
If you would prefer each of the four buffers to appear in its
own individual frame, you can arrange for that. Place the
-cursor in the buffer displaying foo.sas. Enter the
+cursor in the buffer displaying foo.sas. Enter the
sequence C-c C-w. The cursor will normally be in buffer
-foo.sas. If not, put it there and C-x b foo.sas.
+foo.sas. If not, put it there and C-x b foo.sas.
Buffer Mode Description
- foo.sas ESS[SAS]
your source file
- *SAS:1* iESS[SAS:1]
iESS communication buffer
- *SAS:1.log* Shell ESStr []
SAS log information
- *SAS:1.lst* Shell ESSlst []
SAS listing information
+ foo.sas ESS[SAS]
your source file
+ *SAS:1* iESS[SAS:1]
iESS communication buffer
+ *SAS:1.log* Shell ESStr []
SAS log information
+ *SAS:1.lst* Shell ESSlst []
SAS listing information
DATA
or PROC
and end with
-Next: ESS(SAS)--Graphics,
+
+
+Next: ESS(SAS)--Graphics,
Previous: iESS(SAS)--Interactive SAS processes,
Up: ESS for SAS
-
+
10.7 iESS(SAS)–Common problems
@@ -4201,13 +4267,13 @@ an emacs buffer, it is necessary to start SAS wit
(set-file-modes "ess-sas-sh-command" 493)
.
sas
isn't in your executable path; to verify, type
-M-: and at the minibuffer prompt Eval:, type
+M-: and at the minibuffer prompt `Eval:', type
(executable-find "sas")
sas
@@ -4239,10 +4305,12 @@ shell script appears.
-Next: ESS(SAS)--Windows,
+
+
+Next: ESS(SAS)--Windows,
Previous: iESS(SAS)--Common problems,
Up: ESS for SAS
-
+
10.8 ESS(SAS)–Graphics
@@ -4251,7 +4319,7 @@ Up: ESS for SAS
window for SAS batch on Windows or for both SAS batch and interactive
with XWindows on UNIX. If you need to create graphics files and view
them with <F12>, then include the following (either in
-foo.sas or in ~/autoexec.sas):
+foo.sas or in ~/autoexec.sas):
filename gsasfile 'graphics.ps';
goptions device=ps gsfname=gsasfile gsfmode=append;
@@ -4265,9 +4333,11 @@ to be visible on screen, for example:
10.9 ESS(SAS)–Windows
@@ -4292,10 +4362,11 @@ You can use batch. See
11 ESS for BUGS
@@ -4322,10 +4393,12 @@ commands is also supported.
-Next: ESS(BUGS)--Command files,
+
+
+Next: ESS(BUGS)--Command files,
Previous: ESS for BUGS,
Up: ESS for BUGS
-
+
11.1 ESS[BUGS]–Model files
@@ -4382,10 +4455,12 @@ each press of F12 if you re-visit the model file.
-Next: ESS(BUGS)--Log files,
+
+
+Next: ESS(BUGS)--Log files,
Previous: ESS(BUGS)--Model files,
Up: ESS for BUGS
-
+
11.2 ESS[BUGS]–Command files
@@ -4411,9 +4486,11 @@ which defaults to 32.
11.3 ESS[BUGS]–Log files
@@ -4429,10 +4506,11 @@ appends it.
-Next: Mailing lists/bug reports,
+
+Next: Mailing lists/bug reports,
Previous: ESS for BUGS,
Up: Top
-
+
12 Other features of ESS
@@ -4452,15 +4530,16 @@ Up: Top
12.1 Syntactic highlighting of buffers
-turn-on-font-lock
to inferior-ess-mode-hook
,
ess-mode-hook
and ess-transcript-mode-hook
. Your systems
-administrator may have done this for you in ess-site.el
+administrator may have done this for you in ess-site.el
(see Customization).
TRUE
.
+matrix labels, and literals such as `NA' and TRUE
.
12.2 Parenthesis matching
@@ -4518,10 +4598,11 @@ initialisation file:
12.3 Using graphics with ESS
@@ -4539,10 +4620,11 @@ features for dealing with such plots.
12.3.1 Using ESS with the
@@ -4562,10 +4644,11 @@ is issued, which displays the current figure.
printer()
driver12.3.2 Using ESS with windowing devices
@@ -4581,9 +4664,10 @@ DISPLAY before the ESS process is started if the variable
12.3.3 Java Graphics Device
@@ -4602,10 +4686,11 @@ this information.)
12.4 Imenu
@@ -4626,10 +4711,11 @@ by various ESS variables such as ess-imenu-S-generic-expression
.
12.5 Toolbar
@@ -4643,10 +4729,11 @@ to change the toolbar.
12.6 TAGS
@@ -4676,9 +4763,10 @@ change the single quotes to double quotes.
12.7 Rdired
@@ -4717,10 +4805,12 @@ deletion (`x' will actually perform the deletion).
13 Bugs and Bug Reporting, Mailing Lists
@@ -4733,10 +4823,11 @@ Up: Top
-Next: Reporting Bugs,
+
+Next: Reporting Bugs,
Previous: Mailing lists/bug reports,
Up: Mailing lists/bug reports
-
+
13.1 Bugs
@@ -4774,10 +4865,11 @@ mechanism.
13.2 Reporting Bugs
@@ -4805,9 +4897,10 @@ donations are also more than welcome.
13.3 Mailing Lists
@@ -4841,17 +4934,18 @@ low-volume mailing list.
Appendix A Customizing ESS
Key (Character) Index
@@ -4880,10 +4975,11 @@ Up: Top
-Next: Variable and command index,
+
+Next: Variable and command index,
Previous: Key Index,
Up: Top
-
+
Concept Index
@@ -4891,8 +4987,8 @@ Up: Top
-
Variable and command index
--
2.11.4.GIT