1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
|
<html lang="en">
<head>
<title>ESS -- Emacs Speaks Statistics</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="ESS -- Emacs Speaks Statistics">
<meta name="generator" content="makeinfo 4.8">
<link title="Top" rel="top" href="#Top">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<h1 class="settitle">ESS -- Emacs Speaks Statistics</h1>
<h2 class="majorheading"><a name="TOC0"></a>ESS — Emacs Speaks Statistics</h2>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Top"></a>
nächstes: <a rel="next" accesskey="n" href="#Introduction">Introduction</a>,
voriges: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
aufwärts: <a rel="up" accesskey="u" href="#dir">(dir)</a>
</div>
<h2 class="unnumbered">ESS: Emacs Speaks Statistics</h2>
<p>ESS version
5.2.6
<pre class="display"> by A.J. Rossini,
R.M. Heiberger,
K. Hornik,
M. Maechler,
R.A. Sparapani
and S.J. Eglen.
</pre>
<!-- (Formerly: Doug -->
<!-- Bates, Ed Kademan, Frank Ritter and David Smith). -->
<blockquote>
Emacs Speaks Statistics (ESS) provides an intelligent, consistent
interface between the user and the software. ESS interfaces with
SAS, S-PLUS, R, BUGS and other statistical analysis packages under
the Unix, Microsoft Windows, and Apple Mac operating systems. ESS
is itself a package within the emacs text editor and uses emacs
features to streamline the creation and use of statistical software.
ESS knows the syntax and grammar of statistical analysis packages
and provides consistent display and editing features based on that
knowledge. ESS assists in interactive and batch execution of
statements written in these statistical analysis languages.
</blockquote>
<ul class="menu">
<li><a accesskey="1" href="#Introduction">Introduction</a>: Overview of features provided by this package
<li><a accesskey="2" href="#Installation">Installation</a>: Installing ESS on your system
<li><a accesskey="3" href="#Interactive-ESS">Interactive ESS</a>: Interacting with statistical programs
<li><a accesskey="4" href="#Entering-commands">Entering commands</a>: Interacting with the ESS process
<li><a accesskey="5" href="#Transcript-Mode">Transcript Mode</a>: Manipulating saved transcript files
<li><a accesskey="6" href="#ESS-for-the-S-family">ESS for the S family</a>
<li><a accesskey="7" href="#Editing">Editing</a>: How to create/edit objects and functions
<li><a accesskey="8" href="#Editing-R-documentation-files">Editing R documentation files</a>
<li><a accesskey="9" href="#Help">Help</a>: Reading help files
<li><a href="#ESS-for-SAS">ESS for SAS</a>
<li><a href="#ESS-for-BUGS">ESS for BUGS</a>
<li><a href="#Miscellaneous">Miscellaneous</a>: Other features of ESS
<li><a href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>: How to get assistance with ESS
<li><a href="#Customization">Customization</a>: Customizing ESS
<li><a href="#Key-Index">Key Index</a>
<li><a href="#Concept-Index">Concept Index</a>
<li><a href="#Variable-and-command-index">Variable and command index</a>
<!-- @detailmenu -->
<!-- The Detailed Node Listing - -->
<!-- Introduction to ESS -->
<!-- * Features:: Why should I use ESS? -->
<!-- * New features:: -->
<!-- * Credits:: Authors of and contributors to ESS -->
<!-- * Latest version:: Getting the latest version of ESS -->
<!-- * Manual:: How to read this manual -->
<!-- Installing ESS on your system -->
<!-- * Unix installation:: Installing ESS on your Unix system -->
<!-- * Microsoft Windows installation:: Installing ESS on your MS Windows system -->
<!-- * Requirements:: emacs, Operating Systems and Statistical Packages -->
<!-- * System dependent:: Other variables you may need to change -->
<!-- Starting the ESS process -->
<!-- * Multiple ESS processes:: -->
<!-- * ESS processes on Remote Computers:: -->
<!-- * Customizing startup:: Changing the startup actions -->
<!-- Help for the S family -->
<!-- * ESS(S)-Editing files:: -->
<!-- * iESS(S)-Inferior ESS processes:: -->
<!-- * Handling and Reusing Transcripts:: -->
<!-- * ESS-help-assistance with viewing help:: -->
<!-- * Philosophies for using ESS(S):: -->
<!-- * Scenarios for use (possibilities-based on actual usage):: -->
<!-- * Customization Examples and Solutions to Problems:: -->
<!-- Help for SAS -->
<!-- * ESS(SAS)-Design philosophy:: -->
<!-- * ESS(SAS)-Editing files:: -->
<!-- * iESS(SAS)-Interactive SAS processes:: -->
<!-- * ESS(SAS)-Batch SAS processes:: -->
<!-- * ESS(SAS)-Function keys for batch processing:: -->
<!-- * ESS(SAS)-TAB key:: -->
<!-- * ESS(SAS)-Usage scenarios:: -->
<!-- * iESS(SAS)-Common problems:: -->
<!-- * ESS(SAS)-MS Windows:: -->
<!-- Interacting with the ESS process -->
<!-- * Command-line editing:: Entering commands and fixing mistakes -->
<!-- * Completion:: Completion of object names -->
<!-- * Completion details:: Advanced completion concepts -->
<!-- * Transcript:: Manipulating the transcript -->
<!-- * Command History:: Command History -->
<!-- * History expansion:: References to historical commands -->
<!-- * Hot keys:: Hot keys for common commands -->
<!-- * Statistical Process running in ESS?:: -->
<!-- * Other:: Other commands provided by inferior-ESS -->
<!-- Manipulating the transcript -->
<!-- * Last command:: Manipulating the output from the last command -->
<!-- * Process buffer motion:: Viewing older commands -->
<!-- * Transcript resubmit:: Re-submitting commands from the transcript -->
<!-- * Saving transcripts:: Keeping a record of your S session -->
<!-- Editing S functions -->
<!-- * Edit buffer:: Edit objects in a specialized buffer -->
<!-- * Loading:: Loading source files into the ESS process -->
<!-- * Error Checking:: Detecting errors in source files -->
<!-- * Evaluating code:: Sending code to the ESS process -->
<!-- * Indenting:: Indenting and formatting @Sl{} code -->
<!-- * Other edit buffer commands:: Commands for motion, completion and more -->
<!-- * Source Files:: Maintaining @Sl{} source files -->
<!-- * Source Directories:: Names and locations of dump files -->
<!-- Manipulating saved transcript files -->
<!-- * Resubmit:: Resubmitting commands from the transcript file -->
<!-- * Clean:: Cleaning transcript files -->
<!-- Other features of ESS -->
<!-- * Highlighting:: Syntactic highlighting of buffers -->
<!-- * Graphics:: Using graphics with ESS -->
<!-- * Object Completion:: -->
<!-- Using graphics with ESS -->
<!-- * printer:: The printer() graphics driver -->
<!-- * X11:: The X11() (and other X-windows based) driver -->
<!-- Bugs and Bug Reporting, Mailing Lists -->
<!-- * Bugs:: -->
<!-- * Reporting Bugs:: -->
<!-- * Mailing Lists:: -->
<!-- Customizing ESS -->
<!-- * Variables:: Variables for customization -->
<!-- * Hooks:: Customizing ESS with hooks -->
<!-- * Keybindings:: Changing the default ESS keybindings -->
<!-- Variables for customization -->
<!-- * Variables for starting ESS:: Variables for starting ESS -->
<!-- * Dump file variables:: Variables for dump files -->
<!-- * Indentation variables:: Variables controlling indentation -->
<!-- * Variables controlling interaction:: Variables controlling interaction -->
<!-- with the ESS process -->
<!-- @end detailmenu -->
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Introduction"></a>
nächstes: <a rel="next" accesskey="n" href="#Installation">Installation</a>,
voriges: <a rel="previous" accesskey="p" href="#Top">Top</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">1 Introduction to ESS</h2>
<p><a name="index-introduction-1"></a>
The S family (S, Splus and R) and SAS statistical analysis packages
provide sophisticated statistical and graphical routines for manipulating
data. <b>E</b>macs <b>S</b>peaks <b>S</b>tatistics (ESS) is based on the merger
of two pre-cursors, S-mode and SAS-mode, which provided support for the
S family and SAS respectively. Later on, Stata-mode was also incorporated.
<p>ESS provides a common, generic, and useful interface, through emacs, to
many statistical packages. It currently supports the S family, SAS, BUGS,
Stata and XLisp-Stat with the level of support roughly in that order.
<p>A bit of notation before we begin. <em>emacs</em> refers to both
<em>GNU Emacs</em> by the Free Software Foundation, as well as
<em>XEmacs</em> by the XEmacs Project. The emacs major
mode <code>ESS[language]</code>, where <code>language</code> can take values such as
<code>S</code>, <code>SAS</code>, or <code>XLS</code>. The inferior process interface
(the connection between emacs and the running process) referred to as inferior ESS
(<code>iESS</code>), is denoted in the modeline by <code>ESS[dialect]</code>, where
<code>dialect</code> can take values such as <code>S3</code>, <code>S4</code>, <code>S+3</code>,
<code>S+4</code>, <code>S+5</code>, <code>S+6</code>, <code>S+7</code>, <code>R</code>, <code>XLS</code>, <code>VST</code>, <code>SAS</code>.
<p>Currently, the documentation contains many references to <cite>`S'</cite>
where actually any supported (statistics) language is meant, i.e., `S'
could also mean `XLisp-Stat' or `SAS'.
<p><a name="index-interactive-use-of-S-2"></a>
<a name="index-using-S-interactively-3"></a>For exclusively interactive users of S, ESS provides a number of
features to make life easier. There is an easy to use command history
mechanism, including a quick prefix-search history. To reduce typing,
command-line completion is provided for all S objects and “hot
keys” are provided for common S function calls. Help files are
easily accessible, and a paging mechanism is provided to view them.
Finally, an incidental (but very useful) side-effect of ESS is that a
transcript of your session is kept for later saving or editing.
<p><a name="index-transcripts-of-S-sessions-4"></a>No special knowledge of Emacs is necessary when using S
interactively under ESS.
<p><a name="index-programming-in-S-5"></a>For those that use S in the typical edit–test–revise cycle when
programming S functions, ESS provides for editing of S functions
in Emacs edit buffers. Unlike the typical use of S where the editor
is restarted every time an object is edited, ESS uses the current Emacs
session for editing. In practical terms, this means that you can edit
more than one function at once, and that the ESS process is still
available for use while editing. Error checking is performed on
functions loaded back into S, and a mechanism to jump directly to the
error is provided. ESS also provides for maintaining text versions of
your S functions in specified source directories.
<ul class="menu">
<li><a accesskey="1" href="#Features">Features</a>: Why should I use ESS?
<li><a accesskey="2" href="#New-features">New features</a>
<li><a accesskey="3" href="#Credits">Credits</a>: Authors of and contributors to ESS
<li><a accesskey="4" href="#Latest-version">Latest version</a>: Getting the latest version of ESS
<li><a accesskey="5" href="#Manual">Manual</a>: How to read this manual
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Features"></a>
nächstes: <a rel="next" accesskey="n" href="#New-features">New features</a>,
voriges: <a rel="previous" accesskey="p" href="#Introduction">Introduction</a>,
aufwärts: <a rel="up" accesskey="u" href="#Introduction">Introduction</a>
</div>
<h3 class="section">1.1 Why should I use ESS?</h3>
<p>Statistical packages are powerful software systems for manipulating and
analyzing data, but their user interfaces often leave something something
to be desired: they offer weak editor functionality and they differ
among themselves so markedly that you have to re-learn how to do those
things for each package. ESS is a package which is designed to make
editing and interacting with statistical packages more uniform,
user-friendly and give you the power of emacs as well.
<p>ESS provides several features which make it easier to interact with the
ESS process (a connection between your buffer and the statistical
package which is waiting for you to input commands). These include:
<ul>
<li><b>Command-line editing</b> for fixing mistakes in commands before they are
entered. The `<samp><span class="samp">-e</span></samp>' flag for S-plus provides something similar to
this, but here you have the full range of Emacs commands rather than a
limited subset. However, other packages such as XLisp-Stat and S3 do not
necessarily have features like this built-in.
Siehe <a href="#Command_002dline-editing">Command-line editing</a>.
<li><b>Searchable command history</b> for recalling previously-submitted
commands. This provides all the features of the `<samp><span class="samp">Splus -e</span></samp>' history
mechanism, plus added features such as history searching.
Siehe <a href="#Command-History">Command History</a>.
<li><b>Command-line completion</b> of both object and file names for quick
entry. This is similar to <code>tcsh</code>'s facility for filenames; here it
also applies to object names and list components.
Siehe <a href="#Completion">Completion</a>.
<li><b>Hot-keys</b> for quick entry of commonly-used commands in `S' such as
<code>objects()</code> and <code>search()</code>.
Siehe <a href="#Hot-keys">Hot keys</a>.
<li><b>Transcript recording</b> for a complete record of all the actions in an
S session.
Siehe <a href="#Transcript">Transcript</a>.
<li><b>Interface to the help system</b>, with a specialized mode for viewing S
help files.
Siehe <a href="#Help">Help</a>.
</ul>
<p>If you commonly create or modify S functions, you will have found
the standard facilities for this (the `<samp><span class="samp">fix()</span></samp>' 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
features:
<ul>
<li><b>Object editing</b>. ESS allows you to edit more than one function
simultaneously in dedicated Emacs buffers. The ESS process may
continue to be used while functions are being edited.
Siehe <a href="#Edit-buffer">Edit buffer</a>.
<li><b>A specialized editing mode</b> for S code, which provides syntactic
indentation and highlighting.
Siehe <a href="#Indenting">Indenting</a>.
<li><b>Facilities for loading and error-checking source files</b>, including a
keystroke to jump straight to the position of an error in a source file.
Siehe <a href="#Error-Checking">Error Checking</a>.
<li><b>Source code revision maintenance</b>, which allows you to keep historic
versions of S source files.
Siehe <a href="#Source-Files">Source Files</a>.
<li><b>Facilities for evaluating S code</b> such as portions of source
files, or line-by-line evaluation of files (useful for debugging).
Siehe <a href="#Evaluating-code">Evaluating code</a>.
</ul>
<p>Finally, ESS provides features for re-submitting commands from saved
transcript files, including:
<ul>
<li><b>Evaluation of previously entered commands</b>, stripping away
unnecessary prompts.
Siehe <a href="#Transcript-resubmit">Transcript resubmit</a>.
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="New-features"></a>
nächstes: <a rel="next" accesskey="n" href="#Credits">Credits</a>,
voriges: <a rel="previous" accesskey="p" href="#Features">Features</a>,
aufwärts: <a rel="up" accesskey="u" href="#Introduction">Introduction</a>
</div>
<h3 class="section">1.2 New features in ESS</h3>
<p>Changes/New Features in 5.2.6:
<ul>
<li>Removed non-ASCII characters in a few files.
<li>ESS[R]: now works better when UTF-8 locale is active; in
particular, you get correct directional quotes in R's startup message
for R-devel (unstable development version of R 2.1.0) when using
environment variables LANGUAGE=en@quot LC_ALL=en_US.UTF-8
<li>ESS[SAS]: toggling of .log mode improved (<kbd>F10</kbd>); toggling of
.lst mode now also available (<kbd>C-F10</kbd>); killing all buffers associated
with .sas program no longer bound to <kbd>C-F10</kbd> since its a bit overzealous;
EXPERIMENTAL new feature: if your .log grows to more than 2.5MB, just
the first 2.5MB are refreshed; this is helpful when your .sas program
generates lots of error messages and gets too big for emacs to display;
the truncation size is controlled by the variable ess-sas-log-max and
defaults to 2500000.
<li>S-Plus 7 for Windows is now recognized.
<li>ESS[S] (incl. R): in auto-fill mode, strings are not wrapped anymore.
<li>ESS[S] (incl. R): font-lock now correctly differs between R and S,
e.g., for "_"; both now fontify warning(.) and S does terminate() additionally.
<li>Support for `bell' aka `beep' aka `ding' aka `alarm' in all inferior
modes: When \a is output “to the the console” at the beginning of a line,
the bell is rung.
</ul>
<p>Changes/New Features in 5.2.5:
<ul>
<li>ESS[R]: <kbd>C-c C-q</kbd> or `<samp><span class="samp">Quit S</span></samp>' from the menu now should work
(again and less klunkily) and do not append `<samp><span class="samp">-exited</span></samp>' to the
buffer name. Further, the behavior of <code>(ess-cleanup)</code>, called from
ess-quit, now depends on the new customizable variable
<code>ess-S-quit-kill-buffers-p</code> which defaults to <code>nil</code>.
Consequently, the question <em>“Delete all buffers associated
with ..?”</em> will not be asked anymore by default.
<li>ESS[SAS] – ess-ebcdic-to-ascii-search-and-replace will now work
with the <code>recode</code> application as well which is available on many platforms
<li>ESS[S] (incl. R): Name completion for slots of S4 objects now works!
</ul>
<p>Changes/New Features in 5.2.4:
<ul>
<li>The documentation now includes an overview of how to use the emacs
TAGS facility for S functions. (The distribution also used to contain a
directory <samp><span class="file">etc/other/Tags</span></samp> where a ~1990 version of <samp><span class="file">etags.c</span></samp> was
distributed; this is no longer relevant and so has been deleted.)
<li>ESS[SAS] – When you are working with EBCDIC files on an ASCII
platform, .log NOTEs may display as gibberish since the EBCDIC
characters are not converted to ASCII prior to their display. So,
the function ess-ebcdic-to-ascii-search-and-replace is provided for
convenience and is bound to <kbd>C-F11</kbd>. This function requires the
<code>dd</code> command (only available on unix or unix-like platforms).
<li>ESS: Completion of object names is now always done dynamically rather
than allowing the option of using a pre-computed database (by
<code>ess-create-object-name-db</code>) since modern computers seem fast
enough for dynamic completion. (We expect few users, if any, have
been using the pre-computed database method.)
<li>ESS: object completion in iESS buffers running on Windows was
very slow (for GNU Emacs, but not XEmacs) and has now been fixed.
Further, it was more or less broken for all versions of S-plus 6.x,
and has been fixed to work everywhere but with the Windows' GUI of
S-plus. The list of objects now shows unique names also when an
object appears more than once in the search path.
<li>ESS[R]: Completion of object names now also includes those
starting with “.”.
</ul>
<p>Changes/New Features in 5.2.3:
<ul>
<li>ESS: When new inferior ESS processes are created, by default they
will replace the current buffer (this restores behavior from pre
5.2.0). If you wish new ESS processes to start in another window of the
current frame, set inferior-ess-same-window to nil.
<li>New variables inferior-Splus-args and inferior-R-args provide a
way to pass command line arguments to starting S and R processes.
</ul>
<p>Changes/New Features in 5.2.2:
<ul>
<li>bug-fixes for 5.2.1 (require 'executable), html docs, etc.
<li>ess-lisp-directory/../doc/info added to Info-directory-list
if ess-info not found by info
<li>ESS[R]: If you have other versions of R on your
exec-path, such as "R-1.8.1" with Unix or "rw1081" with Windows,
ESS will find them and create appropriate functions, such as M-x
R-1.8.1 or M-x rw1081, for calling them.
By default only Unix programs beginning "R-1" and
"R-2" and Windows programs parallel to the
version of R in your exec-path will be found,
but see ess-r-versions and ess-rterm-versions for ways to find other
versions of R.
<li>ESS[R]: Other versions of R, such as "R-1.8.1" on Unix and "rw1081" on
Windows, are added to the
"ESS / Start Process / Other" menu.
<li>ESS[S]: If you have other versions of S-Plus on your Windows computer,
such as S-Plus 6.1 or S-Plus 4.5, ESS will find them and create appropriate
functions, such as M-x splus61, for calling the console version (Sqpe)
inside an emacs buffer. By default only
programs installed in the default location will be found, but see
ess-SHOME-versions for ways to find other versions of S-Plus.
<li>ESS[S]: Other versions of Sqpe on Windows, such as "splus61",
are added to the
"ESS / Start Process / Other" menu.
<li>ESS[R]: (bug fix) ess-quit (bound to C-c C-q) should now quit the
inferior R process, when issued from either the inferior buffer, or from
a .R buffer.
</ul>
<p>Changes/New Features in 5.2.1:
<ul>
<li>ESS[S] (R and S-plus): now have toolbar support
with icons to evaluate code in the inferior process or to switch
there. This code is experimental and likely to change as XEmacs/Emacs
issues get resolved. The toolbar should be enabled if your Emacs
displays images, but can be disabled with the variable ess-use-toolbar.
Thanks to David Smith from Insightful for the S-plus logo.
<li>ESS[SAS]: ess-sas-graph-view (F12) enhanced; you can specify
external file viewers for each graphics file type via the alist
ess-sas-graph-view-viewer-alist; also .jpg/.gif are now handled
by image-mode on XEmacs, if available, otherwise by graphics
primitives as before
</ul>
<p>Changes/New Features in 5.2.0:
<ul>
<li>ESS[BUGS]: new info documentation! now supports interactive
processing thanks to <a href="mailto:Aki.Vehtari@hut.fi">Aki Vehtari</a>;
new architecture-independent unix support as well as support for BUGS v. 0.5
<li>ESS[SAS]: convert .log to .sas with ess-sas-transcript;
info documentation improved; Local Variable bug fixes;
SAS/IML statements/functions now highlighted; files edited
remotely by ange-ftp/EFS/tramp are recognized and pressing
SUBMIT opens a buffer on the remote host via the local variable
ess-sas-shell-buffer-remote-init which defaults to "ssh";
changed the definition of the variable ess-sas-edit-keys-toggle
to boolean rather than 0/1; added the function ess-electric-run-semicolon
which automatically reverse indents lines containing only "run;";
C-F1 creates MS RTF portrait from the current buffer;
C-F2 creates MS RTF landscape from the current buffer;
C-F9 opens a SAS DATASET with PROC INSIGHT rather than PROC FSVIEW;
"inferior" aliases for SAS batch: C-c C-r for submit region,
C-c C-b for submit buffer, C-c C-x for goto .log; C-c C-y for goto .lst
<li>ESS[S]: Pressing underscore ("_") once inserts " <- " (as before);
pressing underscore twice inserts a literal underscore. To stop this
smart behaviour, add "(ess-smart-underscore nil)" to your .emacs after
ess-site has been loaded;
ess-dump-filename-template-proto (new name!) now can be
customized successfully (for S language dialects);
Support for Imenu has been improved; set ess-imenu-use-S to non-nil to
get an "Imenu-S" item on your menubar;
ess-help: Now using nice underlines (instead of `nuke-* ^H_')
<li>ESS[R]: After (require 'essa-r), M-x ess-r-var allows to load
numbers from any Emacs buffer into an existing *R* process;
M-x ess-rdired gives a “directory editor” of R objects;
fixed ess-retr-lastvalue-command, i.e. .Last.value bug
(thanks to David Brahm)
<li>ESS: Support for creating new window frames has been added to
ESS. Inferior ESS processes can be created in dedicated frames by
setting inferior-ess-own-frame to t. ESS help buffers can also open in
new frames; see the documentation for ess-help-own-frame for details.
(Thanks to Kevin Rodgers for contributing code.)
</ul>
<p>Changes/New Features in 5.1.24:
<ul>
<li>The version number is now correct even inside ESS/Emacs
</ul>
<p>Changes/New Features in 5.1.23:
<ul>
<li>Minor more Makefile clean up.
</ul>
<p>Changes/New Features in 5.1.22:
<ul>
<li>Besides info documentation, PDF and HTML
documentation are also provided (instead of built using "make") and available
on the web as well; see <a href="http://ess.r-project.org/">ESS web page</a> and <a href="http://lib.stat.cmu.edu/general/ESS/doc">StatLib</a>
<li>Now that info documentation is available, the
README.* files are no longer supported. However, they
are still distributed for what it's worth.
<li>ESS is now an XEmacs package! See
<a href="http://www.xemacs.org/Install/index.html">XEmacs Installation HOWTO</a>
for details (specifically, items 10-15).
<li>ESS[SAS]: more user-friendly enhancements for remote
SAS batch jobs with Kermit file transfers (LOG and OUTPUT
function key features now supported). Multiple shells
now supported so you can run SAS on different computers
from different buffers by setting the buffer-local variable
ess-sas-shell-buffer to unique buffer names.
<li>Major re-vamping of Makefile/Makeconf.
</ul>
<p>Changes/New Features in 5.1.21:
<ul>
<li>ESS[SAS]: info documentation now available!, see
ESS->Help for SAS; F12 opens GSASFILE nearest point for viewing
either within emacs, when available, or via an external viewer;
more syntax highlighting keywords; more enhancements for remote
SAS batch jobs with Kermit; new framework for remote SAS interactive
jobs, see ess-remote
<li>ESS[S]: info documentation now available!, see
ESS->Help for the S family
<li>Makefile: tag now independent of rel; info files
made by doc/Makefile and installed in new info sub-directory
</ul>
<p>Changes/New Features in 5.1.20:
<ul>
<li>New `options()$STERM' in the S dialects (S, S-Plus, R).
The S program can determine the environment in which it is
currently running. ESS sets the option to `iESS' or `ddeESS'
when it starts an S language process. We recommend other specific
values for S language processes that ESS does not start.
<li>New `ess-mouse-me' function, assigned to S-mouse-3 by default.
User may click on a word or region and then choose from the
menu to display the item, or a summary, or a plot, etc.
This feature is still under development.
<li>GNU Emacs 21.1 is now supported (fixed for S dialects, SAS & BUGS),
(some from Stephen Eglen).
<li>XEmacs 21.x is now supported (fixed w32-using-nt bug)
<li>XEmacs on Win (NT) is better supported.
<li>Workaround for bug in Sqpe+6 (S-PLUS 6 for Win).
<li>should now work even when imenu is not available (for old XEmacsen).
<li>ESS[SAS]: XEmacs-Imenu fix; C-TAB is globalized along with your
function-key definitions, if specified; you can specify your SAS
library definitions outside of autoexec.sas for ess-sas-data-view
with SAS code placed in the variable ess-sas-data-view-libname,
also the dataset name is defaulted to the nearest permanent dataset
to point; Speedbar support now works for permanent datasets, please
ignore first./last.; new font-locking is now the default with more
improvements for font-locking PROCs, macro statements, * ; and %* ;
comments; you can toggle sas-log-mode with F10 which will font-lock
your .log (if it isn't too big); submit remote .sas files accessed
with ange-ftp, EFS or Tramp (Kermit is experimental) by setting
ess-sas-submit-method to 'sh; ess-sas-submit-command and
ess-sas-submit-command-options are buffer-local so you can have
local file variable sections at the end of your .sas files to
request different executables or specify special options and the
local file variables are re-read at submit instead of only at file
open so that if you make a change it is picked up immediately;
<li>ESS[BUGS]: font-lock with `in' fixed.
<li>for STATA: font-lock bug fixed.
<li>for Rd mode: C-c C-v and `switch-process' in menu.
further, C-c C-f prefix (Rd-font) for inserting or surrounding a word
by things such as \code{.}, \code{\link{.}}, \emph{.} etc.
<li>new functions (ess-directory-function) and (ess-narrow-to-defun)
ess-directory <-> default-directory logic (Jeff Mincy).
<li>Re-organized Makefile and fixed a few bugs.
</ul>
<p>Changes/New Features in 5.1.19:
<ul>
<li>S+6 now supported (Tony Rossini (Unix) and Rich Heiberger (Windows))
<li>New BUGS support through ESS[BUGS] mode (Rodney Sparapani)
Templates assist you in writing .bug and .cmd code (.cmd and .log
are replaced by .bmd and .bog to avoid emacs extension collisions).
Substitution" parameters facilitate "automagic" generation of
data...in" and "init...in" filenames, "const N=" from your data
file and "monitor()/stats()" commands. Activated by pressing F12.
<li>Fixes for `ess-smart-underscore' SAS breakage (Rich Heiberger)
<li>You can change between PC and Unix, local and global SAS function-key
definitions interactively (Rich Heiberger)
<li>C-Submit a highlighted region to SAS batch (Rodney Sparapani)
<li>New and improved SAS syntax highlighting (Rodney Sparapani)
To get the new functionality, set ess-sas-run-make-regexp to nil.
Also available in .log files via F10.
<li>Open a permanent SAS dataset for viewing via F9 (Rodney Sparapani)
You must have the library defined in autoexec.sas for it to work.
<li>User-friendly defaults for `sas-program', `ess-sas-batch-pre-command'
and `ess-sas-batch-post-command' as well Customize support for these
and other ESS[SAS] variables (Rodney Sparapani)
<li>`ess-sas-suffix-2' now defaults to .dat via F11 (Rodney Sparapani)
<li>Emacs/XEmacs, Unix/Windows issues collectively handled in ess-emcs.el
<li>defadvice solves problem of missing *ESS* (thanks to Jeff Mincy)
<li>Improved manual a bit by including things that were only in `README'.
</ul>
<p>Changes/New Features in 5.1.18:
<ul>
<li>New `ess-smart-underscore' function, now assigned to "_" by default.
Inserts `ess-S-assign' (customizable " <- "), unless inside string
and comments where plain "_" is used instead. (MM)
<li>Fixes for longstanding interactive SAS breakage (RMH)
</ul>
<p>Changes/New Features in 5.1.17:
<ul>
<li>Documentation for Windows Installation (Rich Heiberger)
<li>removal of ess-vars, finalization of customize support (in the
sense that there is no more use of ess-vars, but that we need to
fix ess-cust) (AJ Rossini)
<li>Many small (and large) fixes/contributions (MMaechler)
<li>addition of the "S-equal" variable and provide M-x ess-add-MM-keys
a way to remap "_" to `ess-S-assign', typically " <- ", but
customizable. (MMaechler)
</ul>
<p>Changes/New Features in 5.1.16:
<ul>
<li>BUG FIXES
<li>Better SAS support
</ul>
<p>Changes/New Features in 5.1.15:
<ul>
<li>BUG FIXES
</ul>
<p>Changes/New Features in 5.1.14:
<ul>
<li>Yet more fixes to SAS mode, (Rich Heiberger and Rodney Sparapani)
<li>Customize support (for most Emacsen which support it) (AJRossini)
<li>ARC and ViSta support out of the box, and fixes for XLispStat (AJRossini)
</ul>
<p>Changes/New Features in 5.1.13:
<ul>
<li>Version numbering finally all depending on the ./VERSION file,
thanks to Martin Maechler.
<li>Yet more fixes to SAS mode, thanks to Rich Heiberger.
</ul>
<p>Changes/New Features in 5.1.12:
<ul>
<li>Splus 5.1 stabilized, thanks to Martin Maechler, Bill Venables,
Chuck Taylor, and others.
<li>More fixes to SAS mode, thanks to Rodney Sparapani
and Rich Heiberger.
</ul>
<p>Changes/New Features in 5.1.11:
<ul>
<li>More fixes to Stata mode, thanks to
<a href="mailto:brendan@essex.ac.uk">Brendan Halpin</a>.
<li>fixed bugs in ESS-elsewhere, thanks to many testers
<li>README.SPLUS4WIN has DETAILED instructions for S-PLUS 2000, thanks
to <a href="mailto:brahm@alum.mit.edu">David Brahm</a>.
<li>Fixes to SAS mode, thanks to Rodney Sparapani
</ul>
<p>Changes/New Features in 5.1.10:
<ul>
<li>More fixes to Stata mode
<li>primitive generic version of ESS-elsewhere
<li>Small fixes to SAS/Stata.
</ul>
<p>Changes/New Features in 5.1.9:
<ul>
<li>Stata mode works
<li>Literate Data Analysis using Noweb works
</ul>
<p>Changes/New Features in 5.1.8:
<ul>
<li>Bug fixes
<li>R documentation mode defaults changed
</ul>
<p>Changes/New Features in 5.1.2:
<ul>
<li>able to use inferior iESS mode to
communicate directly with a running S-Plus 4.x process using the
Microsoft DDE protocol. We use the familiar (from Unix ESS) C-c C-n
and related key sequences to send lines from the S-mode file to the
inferior S process. We continue to edit S input files in ESS[S] mode
and transcripts of previous S sessions in ESS Transcript mode. All
three modes know the S language, syntax, and indentation patterns and
provide the syntactic highlighting that eases the programming tasks.
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Credits"></a>
nächstes: <a rel="next" accesskey="n" href="#Latest-version">Latest version</a>,
voriges: <a rel="previous" accesskey="p" href="#New-features">New features</a>,
aufwärts: <a rel="up" accesskey="u" href="#Introduction">Introduction</a>
</div>
<h3 class="section">1.3 Authors of and contributors to ESS</h3>
<p><a name="index-comint-6"></a><a name="index-authors-7"></a><a name="index-credits-8"></a>
The ESS environment is built on the open-source projects of
many contributors, dating back nearly 15 years.
Doug Bates and Ed Kademan wrote S-mode in 1989 to edit S and Splus
files in GNU Emacs. Frank Ritter and Mike Meyer added features,
creating version 2. Meyer and David Smith made further contributions,
creating version 3. For version 4, David Smith provided process
interaction based on Olin Shivers' comint package.
<p>John Sall wrote GNU Emacs macros for SAS source code around 1990.
Tom Cook added more functionality creating SAS-mode which was
distributed in 1994. Also in 1994, A.J. Rossini extended S-mode
to support XEmacs. Together with extensions written by Martin Maechler,
this became version 4.7 and supported S, Splus, and R.
In 1995, Rossini extended SAS-mode to work with XEmacs.
<p>In 1997, Rossini merged S-mode and SAS-mode into a single Emacs
package for statistical programming; the product of this marriage was
called ESS version 5.
<ul>
<li>The multiple process code, and the idea for
<code>ess-eval-line-and-next-line</code> are by Rod Ball.
<li>Thanks to Doug Bates for many useful suggestions.
<li>Thanks to Martin Maechler for reporting and fixing bugs, providing many
useful comments and suggestions, and for maintaining the S-mode mailing
list.
<li>Thanks to Frank Ritter for updates from the previous version, the menu
code, and invaluable comments on the manual.
<li>Thanks to Ken'ichi Shibayama for his excellent indenting code, and many
comments and suggestions.
<li>Last but definitely not least, thanks to the many beta testers of the
S-mode and ESS mailing lists.
</ul>
<p><em>ESS</em> version 5 is being developed and currently maintained by
<ul>
<li><!-- @uref{http://www.analytics.washington.edu/,A.J. Rossini} -->
<a href="mailto:rossini@blindglobe.net">A.J. Rossini</a>
<!-- -->
<li><!-- @uref{http://www.sbm.temple.edu/departments/statistics/,Richard M. Heiberger} -->
<a href="mailto:rmh@temple.edu">Richard M. Heiberger</a>
<!-- -->
<li><!-- @uref{http://www.ci.tuwien.ac.at/~hornik,Kurt Hornik} -->
<a href="mailto:hornik@ci.tuwien.ac.at">Kurt Hornik</a>
<!-- -->
<li><!-- @uref{http://stat.ethz.ch/people/maechler/,Martin Maechler} -->
<a href="mailto:maechler@stat.math.ethz.ch">Martin Maechler</a>
<!-- -->
<li><!-- @uref{http://www.mcw.edu/pcor/rsparapa,Rodney A. Sparapani} -->
<a href="mailto:rsparapa@mcw.edu">Rodney A. Sparapani</a>
<!-- -->
<li><!-- @uref{http://www.anc.ed.ac.uk/~stephen,Stephen Eglen} -->
<a href="mailto:stephen@gnu.org">Stephen Eglen</a>
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Latest-version"></a>
nächstes: <a rel="next" accesskey="n" href="#Manual">Manual</a>,
voriges: <a rel="previous" accesskey="p" href="#Credits">Credits</a>,
aufwärts: <a rel="up" accesskey="u" href="#Introduction">Introduction</a>
</div>
<h3 class="section">1.4 Getting the latest version of ESS</h3>
<p>The latest released version of ESS is always available on the web at:
<a href="http://ess.r-project.org">ESS web page</a> or
<a href="http://lib.stat.cmu.edu/general/ESS/">StatLib</a>
<!-- There no longer is an anonymous CVS repository for ESS, due to lack of -->
<!-- interest, little demand, and problems with security. -->
<!-- text below modified from R-admin.texi (thanks to Kurt for the tip). -->
<p>The latest development version of ESS is available via
<a href="https://svn.R-project.org/ESS/">https://svn.R-project.org/ESS/</a>, the ESS Subversion repository. If
you have a Subversion client (see <a href="http://subversion.tigris.org/">http://subversion.tigris.org/</a>),
you can download the sources using:
<pre class="smallexample"> % svn checkout https://svn.r-project.org/ESS/trunk <var>path</var>
</pre>
<p class="noindent">which will put the ESS files into directory <var>path</var>. Later,
within that directory, `svn update' will bring that directory up to
date. Windows-based tools such as TortoiseSVN are also available for
downloading the files. Alternatively, you can browse the sources with a
web browser at: <a href="https://svn.r-project.org/ESS/trunk">ESS SVN site</a>. However, please use a subversion client instead to minimize the
load when retrieving.
<p>If you remove other versions of ESS from your emacs load-path, you can
then use the development version by adding the following to .emacs:
<pre class="example"> (load "/path/to/ess-svn/lisp/ess-site.el")
</pre>
<p>Note that https is required, and that the SSL certificate for the
Subversion server of the R project is
<pre class="smallexample"> Certificate information:
- Hostname: svn.r-project.org
- Valid: from Jul 16 08:10:01 2004 GMT until Jul 14 08:10:01 2014 GMT
- Issuer: Department of Mathematics, ETH Zurich, Zurich, Switzerland, CH
- Fingerprint: c9:5d:eb:f9:f2:56:d1:04:ba:44:61:f8:64:6b:d9:33:3f:93:6e:ad
</pre>
<p class="noindent">(currently, there is no “trusted certificate”). You can accept this
certificate permanently and will not be asked about it anymore.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Manual"></a>
voriges: <a rel="previous" accesskey="p" href="#Latest-version">Latest version</a>,
aufwärts: <a rel="up" accesskey="u" href="#Introduction">Introduction</a>
</div>
<h3 class="section">1.5 How to read this manual</h3>
<p>If you need to install ESS, read <a href="#Installation">Installation</a> for details on what
needs to be done before proceeding to the next chapter.
<p>In this manual we use the standard notation for describing the
keystrokes used to invoke certain commands. <kbd>C-<chr></kbd> means hold
the CONTROL key while typing the character <chr>. <kbd>M-<chr></kbd> means
hold the META or EDIT or ALT key down while typing <chr>. If there is no
META, EDIT or ALT key, instead press and release the ESC key and then
type <chr>.
<p>All ESS commands can be invoked by typing <kbd>M-x command</kbd>. Most of
the useful commands are bound to keystrokes for ease of use. Also, the
most popular commands are also available through the emacs menubar, and
finally, if available, a small subset are provided on the toolbar.
Where possible, keybindings are similar to other modes in emacs to
strive for a consistent user interface within emacs, regardless of the
details of which programming language is being edited, or process being
run.
<p>Some commands, such as <kbd>M-x R</kbd> can accept an optional `prefix'
argument. To specify the prefix argument, you would type <kbd>C-u</kbd>
before giving the command. e.g. If you type <kbd>C-u M-x R</kbd>, you will
be asked for command line options that you wish to invoke the R process
with.
<p>Emacs is often referred to as a `self-documenting' text editor. This
applies to ESS in two ways. First, limited documentation about each ESS
command can be obtained by typing <kbd>C-h f</kbd>. For example, if you type
<kbd>C-h f ess-eval-region</kbd>, documentation for that command will appear
in a separate *Help* buffer. Second, a complete list of keybindings
that are available in each ESS mode and brief description of that mode
is available by typing <kbd>C-h m</kbd> within an ESS buffer.
<p>Emacs is a versatile editor written in both C and lisp; ESS is written
in the Emacs lisp dialect (termed `elisp') and thus benefits from the
flexible nature of lisp. In particular, many aspects of ESS behaviour
can be changed by suitable customization of lisp variables. This manual
mentions some of the most frequent variables. A full list of them
however is available by using the Custom facility within emacs. (Type
<kbd>M-x customize-group RET ess RET</kbd> to get started.)
<a href="#Customization">Customization</a> provides details of common user variables you can
change to customize ESS to your taste, but it is recommended that you
defer this section until you are more familiar with ESS.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Installation"></a>
nächstes: <a rel="next" accesskey="n" href="#Interactive-ESS">Interactive ESS</a>,
voriges: <a rel="previous" accesskey="p" href="#Introduction">Introduction</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">2 Installing ESS on your system</h2>
<p><a name="index-installation-9"></a>
The following section details those steps necessary to get ESS running
on your system.
<ul class="menu">
<li><a accesskey="1" href="#Unix-installation">Unix installation</a>: Installing ESS on your Unix system
<li><a accesskey="2" href="#Microsoft-Windows-installation">Microsoft Windows installation</a>: Installing ESS on your MS Windows system
<li><a accesskey="3" href="#Requirements">Requirements</a>: emacs, Operating Systems and Statistical Packages
</ul>
<!-- FIXME: the following contains @node s *and* is also included by readme.texi -->
<!-- which does *not* include 'requires.texi' -->
<!-- ==> *must* give node pointer problems! -->
<p>We now discuss installation, which might happen under Unix or
Microsoft Windows. First, we discuss Unix installation.
Siehe <a href="#Unix-installation">Unix installation</a>.
<p>For Microsoft Windows Installation please skip to the
Siehe <a href="#Microsoft-Windows-installation">Microsoft Windows installation</a>.
<div class="node">
<p><hr>
<a name="Unix-installation"></a>
nächstes: <a rel="next" accesskey="n" href="#Microsoft-Windows-installation">Microsoft Windows installation</a>,
aufwärts: <a rel="up" accesskey="u" href="#Installation">Installation</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">2.1 Unix installation</h3>
<ol type=1 start=1>
<li>cd to a directory where you want to install ESS, creating it if necessary.
This directory will be referred to below as ESSDIR.
<!-- It will contain, -->
<!-- at the end, the tar file @file{ess-VERSION.tar.gz}, and a directory for -->
<!-- the ESS source, which will be termed "the ESS-VERSION source directory". -->
<!-- Note that the .elc files may be installed elsewhere (as specified in the -->
<!-- Makefile) if desired. -->
<li>Retrieve the latest version from
<a href="http://ess.r-project.org/downloads/ess">ESS downloads area</a>
to ESSDIR.
<li>Decompress/unarchive the files from the disribution.
<pre class="example"> gunzip ess-VERSION.tar.gz
tar xvf ess-VERSION.tar
</pre>
<pre class="display"> (or: <code>gunzip < ess-VERSION.tar.gz | tar xvf -</code> ).
(or using GNU tar: <code>tar zxvf ess-VERSION.tar.gz</code>).
</pre>
<p>The <code>tar</code> command will create the subdirectory ess-VERSION and unarchive
the files there.
<!-- If you are using GNU Emacs 19.29, decompress/unarchive -->
<!-- @file{ESSDIR/ess-VERSION/lisp/19.29.tar.gz}, -->
<!-- read @file{ESSDIR/ess-VERSION/lisp/19.29/README}, follow the instructions -->
<!-- and you might be able to get ESS to work. -->
<!-- @emph{Please note that GNU Emacs 19.29 is no longer supported}. -->
<!-- For a list of supported versions of emacs, see @xref{Requirements}. -->
<li>Edit the file <samp><span class="file">ESSDIR/ess-VERSION/lisp/ess-site.el</span></samp> as explained in the
comments section of that file.
<!-- Installations that are using ESS only for S-Plus -->
<!-- 6.x will probably not need to make any changes. Installations that also -->
<!-- have one or more of (S4, S+3/4/5/6/7, R, SAS, BUGS, XLispStat, Stata) -->
<!-- may need to uncomment corresponding lines in @file{ESSDIR/ess-VERSION/lisp/ess-site.el}. -->
<li> Add the line
<pre class="example"> (load "ESSDIR/ess-VERSION/lisp/ess-site")
</pre>
<p>to your user or system installation file
(GNU Emacs uses <samp><span class="file">$HOME/.emacs</span></samp> and XEmacs uses <samp><span class="file">$HOME/.xemacs/init.el</span></samp>
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).
<p>Alternatively, if ess-site.el is in your current Lisp path, you can do:
<pre class="example"> (require 'ess-site)
</pre>
<p>to configure emacs for ESS.
<li>That's it! If you are installing just a local copy of ESS for yourself,
ESS is now ready to be used. (The remaining step below is for
advanced installation.) To edit statistical programs, load the files
with the requiste extensions (".sas" for SAS, ".S" for S-PLUS, ".R" for
R, and ".lsp" for XLispStat). To start a statistical process within
Emacs, such as R, type <code>M-x R</code>.
<!-- @item -->
<!-- (OPTIONAL) If you are running S-PLUS or R, you might consider -->
<!-- installing the database files. From within emacs, @code{C-x d} to the -->
<!-- directory containing ESS. Now: -->
<!-- @example -->
<!-- M-x S+6 -->
<!-- @end example -->
<!-- to get S running. Once you see the SPLUS prompt, do: -->
<!-- @example -->
<!-- M-x ess-create-object-name-db -->
<!-- @end example -->
<!-- (this will create the file @file{ess-sp6-namedb.el}; if it isn't in the -->
<!-- ESS directory, move it there). -->
<!-- Then, completions will be autoloaded and will not be regenerated for -->
<!-- every session. -->
<!-- For R, do the same, using -->
<!-- @example -->
<!-- M-x R -->
<!-- @end example -->
<!-- and then @code{M-x ess-create-object-name-db} creating -->
<!-- @file{ess-r-namedb.el}; if it isn't in the ESS directory, move it there). -->
<li><b>(OPTIONAL) READ THIS ITEM THOROUGHLY BEFORE STARTING</b>:
<p>If you want to place the compiled files in other locations edit the LISPDIR and INFODIR
entries in <samp><span class="file">Makeconf</span></samp> in the ESSDIR/ess-VERSION directory (if you are using XEmacs,
then you also need to edit the EMACS entry as follows: EMACS=xemacs).
<p>You can compile those files by:
<pre class="example"> make all
</pre>
<p>When that completes successfully, install the compiled files:
<pre class="example"> make install
</pre>
<p>This will install the compiled info files and lisp files. If you are an
XEmacs user, then you should be done. If not, then you may have to
edit/create the file <samp><span class="file">dir</span></samp> that is found in the directory specified
by <code>INFODIR</code>: see the sample <samp><span class="file">dir</span></samp> in ESSDIR/ess-VERSION/doc/info.
If <samp><span class="file">dir</span></samp> does not exist in <code>INFODIR</code>, then the sample
<samp><span class="file">dir</span></samp> will be installed.
<p><em>Note:</em> ESS can be installed for XEmacs as an XEmacs package
much more easily than what has been described anywhere above. However,
the latest ESS version will not be available at the same time as an
XEmacs package; generally, it can take weeks or months to appear in the
latter format. For more information on installing ESS as an XEmacs
package see <a href="http://www.xemacs.org/Documentation/packageGuide.html">Quickstart Package Guide</a>.
<!-- An alternative, if you are running XEmacs and have access to the -->
<!-- XEmacs system directories, would be to place the directory in the -->
<!-- site-lisp directory, and simply type @code{make all} (and copy the -->
<!-- documentation as appropriate). -->
<!-- For GNU Emacs, you would still have to move the files into the top level -->
<!-- site-lisp directory. -->
</ol>
<!-- >>>> FIXME (see comment in ess.texi): error in ``makeinfo readme.texi'' -->
<!-- @node Microsoft Windows installation, , Unix installation, Installation -->
<div class="node">
<p><hr>
<a name="Microsoft-Windows-installation"></a>
nächstes: <a rel="next" accesskey="n" href="#Requirements">Requirements</a>,
voriges: <a rel="previous" accesskey="p" href="#Unix-installation">Unix installation</a>,
aufwärts: <a rel="up" accesskey="u" href="#Installation">Installation</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">2.2 Microsoft Windows installation</h3>
<p>For <b>Microsoft Windows installation</b>, please follow the next steps:
(see separate instructions above for UNIX Siehe <a href="#Unix-installation">Unix installation</a>.
<ol type=1 start=1>
<li>cd to a directory where you keep emacs lisp files, or create a new
directory (for example, <samp><span class="file">c:\emacs\</span></samp>) 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
<samp><span class="file">ess-VERSION.tar.gz</span></samp> or the zip file <samp><span class="file">ess-VERSION.zip</span></samp>, and a
directory
for the ESS source, which will be termed "the ESS-VERSION source
directory".
<li>Retrieve the compressed tar file <samp><span class="file">ess-VERSION.tar.gz</span></samp> or the
zipped file <samp><span class="file">ess-VERSION.zip</span></samp> from one of the FTP or WWW
archive sites
via FTP (or HTTP). Be aware that http browsers on Windows
frequently change the "." and "-" characters in filenames to other
punctuation. Please change the names back to their original form.
<li>Copy <samp><span class="file">ess-VERSION.tar.gz</span></samp> to the location where you want the
ess-VERSION directory, for example to
<samp><span class="file">c:\emacs\ess-VERSION.tar.gz</span></samp>, and cd there. For example,
<pre class="example"> cd c:\emacs
</pre>
<p>Extract the files from the distribution, which will unpack
into a subdirectory, <samp><span class="file">ess-VERSION</span></samp>.
<pre class="example"> gunzip ess-VERSION.tar.gz
tar xvf ess-VERSION.tar
(or: <code>gunzip < ess-VERSION.tar.gz | tar xvf -</code> ).
(or: from the zip file: <code>unzip ess-VERSION.zip</code>)
</pre>
<p>The <code>tar</code> command will extract files into the current directory.
<p>Do not create <samp><span class="file">ess-VERSION</span></samp> yourself, or you will get an extra level
of depth to your directory structure.
<li>Windows users will usually be able to use the `lisp/ess-site.el'
as distributed. Only rarely will changes be needed.
<li>Windows users will need to make sure that the directories for the
software they will be using is in the PATH environment variable. On
Windows 9x, add lines similar to the following to your
<samp><span class="file">c:\autoexec.bat</span></samp>
file:
<pre class="example"> path=%PATH%;c:\progra~1\spls2000\cmd
</pre>
<p>On Windows NT/2000/XP, add the directories to the PATH using the
<code>My Computer/Control Panel/System/Advanced/Environment Variables</code> menu.
Note that the directory containing the program is
added to the PATH, not the program itself. One such line is needed
for each software program. Be sure to use the abbreviation
<code>progra~1</code> and not the long version with embedded blanks. Use
backslashes "\".
<li>Add the line
<pre class="example"> (load "/PATH/ess-site")
</pre>
<p>to your .emacs (or _emacs) file (or default.el or site-init.el, for
a site-wide installation). Replace <code>/PATH</code> above with the
value of ess-lisp-directory as defined in <samp><span class="file">ess-site.el</span></samp>. Use
forwardslashes <code>/</code>.
(GNU Emacs uses the filename <samp><span class="file">%HOME%/.emacs</span></samp> and
XEmacs uses the filename <samp><span class="file">%HOME%/.xemacs/init.el</span></samp>
for the initialization file.)
<li>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).
<li>To run statistical processes under emacs:
<p>To start the S-PLUS [67].x GUI from ESS under emacs:
<pre class="example"> M-x S
(or <code>M-x S+6</code>).
</pre>
<p>You will then be
asked for a pathname ("S starting data directory?"), from which to
start the process. The prompt will propose your current directory
as the default. ESS will start the S-PLUS GUI. There will be
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,
<samp><span class="file">myfile.s</span></samp>) to the S-PLUS Commands Window with the
<code>C-c C-n</code> or <code>C-c C-r</code> keys.
(If you are still using S-PLUS 4.x or 2000, then use <code>M-x S+4</code>.)
<p>To start an S-PLUS [67].x session inside an emacs buffer—and
without the S-PLUS GUI:
<pre class="example"> M-x Sqpe
(or <code>M-x Sqpe+6</code>).
</pre>
<p>You will then be asked for a pathname ("S starting data
directory?"), from which to start the process. The prompt will
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, <samp><span class="file">myfile.s</span></samp>) to the *S+6* buffer with the
<code>C-c C-n</code> or <code>C-c C-r</code> keys.
Interactive graphics are available with Sqpe by using the java
library supplied with S-PLUS 6.1 and newer releases.
Enter the commands:
<pre class="example"> library(winjava)
java.graph()
</pre>
<p>Graphs can be saved from the <code>java.graph</code> device
in several formats, but not PostScript. If you
need a PostScript file you will need to open a separate
<code>postscript</code> device.
(If you are still using S-PLUS 4.x or 2000, then use <code>M-x Sqpe+4</code>.)
<p>To connect to an already running S-PLUS GUI (started, for example,
from the S-PLUS icon):
<pre class="example"> M-x S+6-existing
</pre>
<p>You will then be
asked for a pathname ("S starting data directory?"), from which to
start the process. The prompt will propose your current directory
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,
<samp><span class="file">myfile.s</span></samp>) to the S-PLUS Commands Window with the
<code>C-c C-n</code> or <code>C-c C-r</code> keys.
(If you are still using S-PLUS 4.x or 2000, then use <code>M-x S+4-existing</code>.)
<p>If you wish to run R, you can start it with:
<pre class="example"> M-x R
</pre>
<p>XLispStat can not currently be run with
<pre class="example"> M-x XLS
</pre>
<p>Hopefully, this will change. However, you can still edit with
emacs, and cut and paste the results into the XLispStat
*Listener* Window under Microsoft Windows.
<!-- SAS for Windows uses the batch access with function keys that is -->
<!-- described in -->
<!-- @file{doc/README.SAS}. -->
<!-- @xref{ESS(SAS)-MS Windows}. -->
<!-- The user can also edit SAS files -->
<!-- in an @code{ESS[SAS]} buffer and than manually copy and paste them into -->
<!-- an Editor window in the SAS Display Manager. -->
<!-- For Windows, inferior SAS in an @code{iESS[SAS]} buffer does not work -->
<!-- on the local machine. It does work over a network connection to -->
<!-- SAS running on a remote Unix computer. -->
<!-- Reason: we use ddeclient to interface with programs and SAS doesn't -->
<!-- provide the corresponding ddeserver capability. -->
<!-- @item -->
<!-- (OPTIONAL) If you are running Sqpe or R, you might consider -->
<!-- installing the database files. From within emacs, @code{C-x d} to -->
<!-- the directory containing ESS. Now: -->
<!-- @example -->
<!-- M-x Sqpe+6 -->
<!-- @end example -->
<!-- to get S running. Once you see the SPLUS prompt, do: -->
<!-- @example -->
<!-- M-x ess-create-object-name-db -->
<!-- @end example -->
<!-- (this will create the file @file{ess-s+6-namedb.el}; if it isn't in the -->
<!-- ESS directory, move it there). -->
<!-- Then, completions will be autoloaded and will not be regenerated -->
<!-- for every session. -->
<!-- For R, do the same, using -->
<!-- @example -->
<!-- M-x R -->
<!-- @end example -->
<!-- and then @code{M-x ess-create-object-name-db} creating -->
<!-- @file{ess-r-namedb.el}; if it isn't in the ESS directory, move it -->
<!-- there). -->
<li>That's it!
</ol>
<!-- Requirements duplicated? -->
<!-- @node Requirements, , Microsoft Windows installation, Installation -->
<!-- node-name, next, previous, up -->
<!-- @section Requirements -->
<!-- @include requires.texi -->
<div class="node">
<p><hr>
<a name="Requirements"></a>
voriges: <a rel="previous" accesskey="p" href="#Microsoft-Windows-installation">Microsoft Windows installation</a>,
aufwärts: <a rel="up" accesskey="u" href="#Installation">Installation</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">2.3 Requirements</h3>
<p>ESS has been tested with
<ul>
<li>S-PLUS 3.3-4, 4.5, 2000, 5.0-1, 6.0-2, 7.0
<li>R >=0.49
<li>S4
<li>SAS >=6.12
<li>BUGS 0.5, 0.603
<li>Stata >=6.0
<li>XLispStat >=3.50
</ul>
<p>on the following platforms
<ul>
<li>Linux (all)
<li>Solaris/SunOS (all)
<!-- cannot confirm this right now @item SGI (all) -->
<li>Microsoft Windows 95/98/NT/2000/XP (SPLUS 4.5/2000/6.*, R, SAS and BUGS)
<li>Apple Mac OS (SAS for OS 9 and R for OS X)
</ul>
<p>with the following versions of emacs
<ul>
<li>GNU Emacs 20.3-7, 21.1, 21.3, 21.4
<li>XEmacs 21.0, 21.1.13-14, 21.4.0-8, 21.4.9-13<a rel="footnote" href="#fn-1" name="fnd-1"><sup>1</sup></a>, 21.4.14-15, 21.4.17, 21.5.18
<!-- @item GNU Emacs <20.3 and XEmacs <21.0@footnote{These releases of emacs are no -->
<!-- longer supported, so an upgrade is recommended if you plan to use ESS. -->
<!-- If you have GNU Emacs 19.29, see @xref{Unix installation}. Also, note -->
<!-- that the `custom' library bundled with Emacs 19.34 is too _old_, its API is -->
<!-- incompatible with the `new custom' bundled with recent Emacsen. -->
<!-- The `new custom' for Emacs 19.34 is available for download -->
<!-- @uref{ftp://ftp.dina.kvl.dk/pub/Staff/Per.Abrahamsen/custom/custom-1.9962.tar.gz, here}.} -->
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Interactive-ESS"></a>
nächstes: <a rel="next" accesskey="n" href="#Entering-commands">Entering commands</a>,
voriges: <a rel="previous" accesskey="p" href="#Installation">Installation</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">3 Interacting with statistical programs</h2>
<p>As well as using ESS to edit your source files for statistical programs,
you can use ESS to run these statistical programs. In this chapter, we
mostly will refer by example to running S from within emacs. The emacs
convention is to name such proceses running under its control as
`inferior processes'. This term can be slightly misleading, in which
case these processes can be thought of `interactive processes'. Either
way, we use the term `iESS' to refer to the Emacs mode used to interact
with statistical programs.
<!-- node-name, next, previous, up -->
<ul class="menu">
<li><a accesskey="1" href="#Starting-up">Starting up</a>
<li><a accesskey="2" href="#Multiple-ESS-processes">Multiple ESS processes</a>
<li><a accesskey="3" href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a>
<li><a accesskey="4" href="#S_002belsewhere-and-ESS_002delsewhere">S+elsewhere and ESS-elsewhere</a>
<li><a accesskey="5" href="#Customizing-startup">Customizing startup</a>
</ul>
<div class="node">
<p><hr>
<a name="Starting-up"></a>
nächstes: <a rel="next" accesskey="n" href="#Multiple-ESS-processes">Multiple ESS processes</a>,
voriges: <a rel="previous" accesskey="p" href="#Interactive-ESS">Interactive ESS</a>,
aufwärts: <a rel="up" accesskey="u" href="#Interactive-ESS">Interactive ESS</a>
</div>
<h3 class="section">3.1 Starting an ESS process</h3>
<p><a name="index-starting-ESS-10"></a><a name="index-running-S-11"></a>
To start an S session, simply type <kbd>M-x S RET</kbd>.
<a name="index-S-12"></a>
<a name="index-ESS-process-directory-13"></a><a name="index-starting-directory-14"></a><a name="index-working-directory-15"></a><a name="index-directories-16"></a>
S will then (by default) ask the question
<pre class="example"> S starting data directory?
</pre>
<p class="noindent">Enter the name of the directory you wish to start S from (that is,
the directory you would have <code>cd</code>'d to before starting S from
the shell). This directory should have a <samp><span class="file">.Data</span></samp> subdirectory.
<p>You will then be popped into a buffer
<a name="index-ESS-process-buffer-17"></a><a name="index-process-buffer-18"></a>with name `<samp><span class="samp">*S*</span></samp>' which will be used
for interacting with the ESS process, and you can start entering commands.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Multiple-ESS-processes"></a>
nächstes: <a rel="next" accesskey="n" href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a>,
voriges: <a rel="previous" accesskey="p" href="#Starting-up">Starting up</a>,
aufwärts: <a rel="up" accesskey="u" href="#Interactive-ESS">Interactive ESS</a>
</div>
<h3 class="section">3.2 Running more than one ESS process</h3>
<p><a name="index-Multiple-ESS-processes-19"></a>
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
<a name="index-process-names-20"></a>(process 1) is simply named (using S-PLUS as an example) `<samp><span class="samp">S+3:1</span></samp>'.
<!-- You may start a new process by passing a numeric argument to -->
<!-- @kbd{M-x S}. For example, typing @kbd{ESC 2 M-x S} starts up -->
<!-- an ESS process with name @samp{S2}, in a buffer whose name -->
<!-- is initially @samp{*S2*}. -->
The name of the process is shown in the mode line in square brackets
(for example, `<samp><span class="samp">[S+3:2]</span></samp>'); this is useful if the process buffer is
renamed. Without a prefix argument, <kbd>M-x S</kbd> starts a new ESS
process, using the first available process number. With a prefix
argument (for R), <kbd>C-u M-x R</kbd> allows for the specification of
command line options.
<p><a name="index-ess_002drequest_002da_002dprocess-21"></a>You can switch to any active ESS process with the command
`<samp><span class="samp">M-x ess-request-a-process</span></samp>'. 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.
<!-- SJE - commented outl the default behaviour now is to label *S* rather -->
<!-- than *S:1*. -->
<!-- @vindex ess-plain-first-buffername -->
<!-- For the predecessor to ESS (S-mode 4.8), the initial process was not -->
<!-- visibly numbered, i.e. S instead of S1 was used in the mode-line. To -->
<!-- obtain this behavior, set the variable @code{ess-plain-first-buffername} -->
<!-- to @code{t}. See @file{ess-site} for how to set this for all users. -->
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS-processes-on-Remote-Computers"></a>
nächstes: <a rel="next" accesskey="n" href="#S_002belsewhere-and-ESS_002delsewhere">S+elsewhere and ESS-elsewhere</a>,
voriges: <a rel="previous" accesskey="p" href="#Multiple-ESS-processes">Multiple ESS processes</a>,
aufwärts: <a rel="up" accesskey="u" href="#Interactive-ESS">Interactive ESS</a>
</div>
<h3 class="section">3.3 ESS processes on Remote Computers</h3>
<p><a name="index-Remote-Computers-22"></a><a name="index-ess_002dremote-23"></a><a name="index-ESS_002delsewhere-24"></a><a name="index-S_002belsewhere-25"></a>
ESS works with processes on remote computers as easily as with
processes on the local machine. The recommended way to access a
statistical program on remote computer is to start it from a telnet or
ssh buffer and then connect ESS to that buffer.
<ol type=1 start=1>
<li>Start a new telnet or ssh buffer and connect to the remote computer
(e.g. use `<samp><span class="samp">M-x telnet</span></samp>' or `<samp><span class="samp">M-x ssh</span></samp>'; ssh.el is available at
<a href="ftp://ftp.splode.com/pub/users/friedman/emacs-lisp/ssh.el">ftp://ftp.splode.com/pub/users/friedman/emacs-lisp/ssh.el</a>).
<li>Start the ESS process on the remote machine, for example with one of
the commands `<samp><span class="samp">Splus</span></samp>', or `<samp><span class="samp">R</span></samp>', or `<samp><span class="samp">sas -stdio</span></samp>'.
<li>Enter the ESS command `<samp><span class="samp">M-x ess-remote</span></samp>'. You will be prompted for
a program name. Enter `<samp><span class="samp">sp6</span></samp>' or `<samp><span class="samp">r</span></samp>' or `<samp><span class="samp">sas</span></samp>' or another
valid name. Your telnet process is now known to ESS. All the usual
ESS commands (`<samp><span class="samp">C-c C-n</span></samp>' and its relatives) now work with the S
language processes. For SAS you need to use a different command
`<samp><span class="samp">C-c i</span></samp>' (that is a regular `<samp><span class="samp">i</span></samp>', not a `<samp><span class="samp">C-i</span></samp>') to send
lines from your <samp><span class="file">myfile.sas</span></samp> to the remote SAS process.
`<samp><span class="samp">C-c i</span></samp>' sends lines over invisibly.
<!-- and lets SAS display them formatted correctly as in a SAS log file. -->
With ess-remote you get teletype behavior—the data input, the
log, and the listing all appear in the same buffer. To make this work,
you need to end every PROC and DATA step with a "RUN;" statement. The
"RUN;" statement is what tells SAS that it should process the preceding
input statements.
<li>Graphics (interactive) on the remote machine. If you run X11
(Siehe <a href="#X11">X11</a>, X-windows)
on both the local and remote machines then you should be able to
display the graphs locally by setting the `<samp><span class="samp">DISPLAY</span></samp>' environment
variable appropriately. Windows users can download `<samp><span class="samp">xfree86</span></samp>'
from cygwin.
<li>Graphics (static) on the remote machine.
If you don't run the X window system on the local machine, then you can write
graphics to a file on the remote machine, and display the file in
a graphics viewer on the local machine. Most statistical software can
write one or more of postscript, GIF, or JPEG files.
Depending on the versions of emacs and the operating system that you
are running, emacs itself may display `<samp><span class="samp">.gif</span></samp>' and `<samp><span class="samp">.jpg</span></samp>'
files. Otherwise, a graphics file viewer will be needed.
Ghostscript/ghostview may be downloaded to display `<samp><span class="samp">.ps</span></samp>' and
`<samp><span class="samp">.eps</span></samp>' files. Viewers for GIF and JPEG are usually included with
operating systems. Siehe <a href="#ESS_0028SAS_0029_002d_002dFunction-keys-for-batch-processing">ESS(SAS)–Function keys for batch processing</a>,
for more information on using the F12 key for displaying graphics files
with SAS.
</ol>
<p>Should you or a colleague inadvertently start a statistical process in
an ordinary `<samp><span class="samp">*shell*</span></samp>' buffer, the `<samp><span class="samp">ess-remote</span></samp>' command can
be used to convert it to an ESS buffer and allow you to use the ESS
commands with it.
<p>We have two older commands, now deprecated, for accessing ESS processes
on remote computers.
Siehe <a href="#S_002belsewhere-and-ESS_002delsewhere">S+elsewhere and ESS-elsewhere</a>.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="S+elsewhere-and-ESS-elsewhere"></a>
<a name="S_002belsewhere-and-ESS_002delsewhere"></a>
nächstes: <a rel="next" accesskey="n" href="#Customizing-startup">Customizing startup</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a>,
aufwärts: <a rel="up" accesskey="u" href="#Interactive-ESS">Interactive ESS</a>
</div>
<h3 class="section">3.4 S+elsewhere and ESS-elsewhere</h3>
<p>These commands are now deprecated. We recommend `<samp><span class="samp">ess-remote</span></samp>'. We
have two versions of the elsewhere function. `<samp><span class="samp">S+elsewhere</span></samp>' is
specific for the S-Plus program. The more general function
`<samp><span class="samp">ESS-elsewhere</span></samp>' is not as stable.
<ol type=1 start=1>
<li>Enter `<samp><span class="samp">M-x S+elsewhere</span></samp>'.
You will be prompted for a starting directory. I usually give it my
project directory on the local machine, say `<samp><span class="samp">~myname/myproject/</span></samp>'
<p>Or enter `<samp><span class="samp">M-x ESS-elsewhere</span></samp>'. 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 `<samp><span class="samp">~myname/myproject/</span></samp>'
<li>The `<samp><span class="samp">*S+3*</span></samp>' buffer will appear with a prompt from the
local operating system (the unix prompt on a unix workstation or with
cygwin bash on a PC, or the msdos prompt on a PC without bash). emacs
may freeze because the cursor is at the wrong place. Unfreeze it with
`<samp><span class="samp">C-g</span></samp>' then move the cursor to the end with `<samp><span class="samp">M-></span></samp>'.
With `<samp><span class="samp">S+elsewhere</span></samp>' the buffer name is based on the name of the ESS program.
<li>Enter
`<samp><span class="samp">telnet myname@other.machine</span></samp>' (or `<samp><span class="samp">ssh myname@other.machine</span></samp>').
You will be prompted for your password on the remote machine.
Use
`<samp><span class="samp">M-x send-invisible</span></samp>'
before typing the password itself.
<li>Before starting the ESS process, type `<samp><span class="samp">stty -echo nl</span></samp>'
at the unix prompt. The `<samp><span class="samp">-echo</span></samp>' turns off the echo, the
`<samp><span class="samp">nl</span></samp>' turns off the newline that you see as `<samp><span class="samp">^M</span></samp>'.
<li>You are now talking to the unix prompt on the other machine in the
`<samp><span class="samp">*S+3*</span></samp>' buffer. cd into the directory for the current project and start
the ESS process by entering
`<samp><span class="samp">Splus</span></samp>' or `<samp><span class="samp">R</span></samp>' or `<samp><span class="samp">sas -stdio</span></samp>'
as appropriate. If you can login remotely to your Windows 2000, then
you should be able to run `<samp><span class="samp">Sqpe</span></samp>' on the Windows machine. I haven't
tested this and noone has reported their tests to me. You will not be
able to run the GUI through this text-only connection.
<li>Once you get the S or R or SAS prompt, then you are completely connected.
All the `<samp><span class="samp">C-c C-n</span></samp>' and related commands work correctly in sending
commands from `<samp><span class="samp">myfile.s</span></samp>' or `<samp><span class="samp">myfile.r</span></samp>' on the PC to the
`<samp><span class="samp">*S+3*</span></samp>' buffer running the S or R or SAS program on the remote machine.
<li>Graphics on the remote machine works fine. If you run the X window
sysyem on the remote unix machine you should be able to display them in
`<samp><span class="samp">xfree86</span></samp>' on your PC. If you don't run X11, then you can write
graphics to the postscript device and copy it to your PC with dired and
display it with ghostscript.
</ol>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Customizing-startup"></a>
voriges: <a rel="previous" accesskey="p" href="#S_002belsewhere-and-ESS_002delsewhere">S+elsewhere and ESS-elsewhere</a>,
aufwärts: <a rel="up" accesskey="u" href="#Interactive-ESS">Interactive ESS</a>
</div>
<h3 class="section">3.5 Changing the startup actions</h3>
<p>If you do not wish ESS to prompt for a starting directory when starting
a new process, set the variable <code>ess-ask-for-ess-directory</code> to
<a name="index-ess_002dask_002dfor_002dess_002ddirectory-26"></a><code>nil</code>. In this case, the value of the variable <code>ess-directory</code>
<a name="index-ess_002ddirectory-27"></a>is used as the starting directory. The default value for this variable
is your home directory. If <code>ess-ask-for-ess-directory</code> has a
non-<code>nil</code> value (as it does by default) then the value of
<code>ess-directory</code> provides the default when prompting for the
starting directory. Incidentally, <code>ess-directory</code> is an ideal
variable to set in <code>ess-pre-run-hook</code>.
<p>If you like to keep a record of your S sessions, set the variable
<code>ess-ask-about-transfile</code> to <code>t</code>, and you will be asked for a
filename for the transcript before the ESS process starts.
<div class="defun">
— User Option: <b>ess-ask-about-transfile</b><var><a name="index-ess_002dask_002dabout_002dtransfile-28"></a></var><br>
<blockquote><p>If non-<code>nil</code>, as for a file name in which to save the session
transcript.
</p></blockquote></div>
<p><a name="index-transcript-file-29"></a>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 `<samp><span class="samp">.St</span></samp>'); 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 <a href="#Saving-transcripts">Saving transcripts</a>.)
<p>Once these questions are answered (if they are asked at all) the S
process itself is started by calling the program name specified in the
variable <code>inferior-ess-program</code>.
<a name="index-inferior_002dess_002dprogram-30"></a>If you need to pass any arguments to this program, they may be specified
in the variable <code>inferior-</code><var>S_program_name</var><code>-args</code> (e.g. if
<code>inferior-ess-program</code> is <code>"S+"</code> then the variable to set is
<code>inferior-S+-args</code>.
<a name="index-arguments-to-S-program-31"></a>It is not normally necessary to pass arguments to the S program; in
particular do not pass the `<samp><span class="samp">-e</span></samp>' option to <code>Splus</code>, since ESS
provides its own command history mechanism.
<p>By default, the new process will be displayed in another window in the
current frame. If you wish your S process to appear in a separate
variable, customize the variable <code>inferior-ess-own-frame</code>.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Entering-commands"></a>
nächstes: <a rel="next" accesskey="n" href="#Transcript-Mode">Transcript Mode</a>,
voriges: <a rel="previous" accesskey="p" href="#Interactive-ESS">Interactive ESS</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">4 Interacting with the ESS process</h2>
<p><a name="index-entering-commands-32"></a><a name="index-commands-33"></a><a name="index-sending-input-34"></a>
The primary function of the ESS package is to provide an easy-to-use
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 <a href="emacs.html#Shell-Mode">Shell Mode</a>). Command-line completion of S objects and a number of `hot
keys' for commonly-used S commands are also provided for ease of
typing.
<ul class="menu">
<li><a accesskey="1" href="#Command_002dline-editing">Command-line editing</a>: Entering commands and fixing mistakes
<li><a accesskey="2" href="#Completion">Completion</a>: Completion of object names
<li><a accesskey="3" href="#Completion-details">Completion details</a>: Advanced completion concepts
<li><a accesskey="4" href="#Transcript">Transcript</a>: Manipulating the transcript
<li><a accesskey="5" href="#Command-History">Command History</a>: Command History
<li><a accesskey="6" href="#History-expansion">History expansion</a>: References to historical commands
<li><a accesskey="7" href="#Hot-keys">Hot keys</a>: Hot keys for common commands
<li><a accesskey="8" href="#Statistical-Process-running-in-ESS_003f">Statistical Process running in ESS?</a>
<li><a accesskey="9" href="#Emacsclient">Emacsclient</a>: Using emacsclient
<li><a href="#Other">Other</a>: Other commands provided by inferior-ESS
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Command-line-editing"></a>
<a name="Command_002dline-editing"></a>
nächstes: <a rel="next" accesskey="n" href="#Completion">Completion</a>,
voriges: <a rel="previous" accesskey="p" href="#Entering-commands">Entering commands</a>,
aufwärts: <a rel="up" accesskey="u" href="#Entering-commands">Entering commands</a>
</div>
<h3 class="section">4.1 Entering commands and fixing mistakes</h3>
<p><a name="index-command_002dline-editing-35"></a>
Sending a command to the ESS process is as simple as typing it in
and pressing the <RETURN> key:
<ul>
<li><kbd>RET</kbd> (<code>inferior-ess-send-input</code>) <br>
<a name="index-inferior_002dess_002dsend_002dinput-36"></a>Send the command on the current line to the ESS process.
</ul>
<p>If you make a typing error before pressing <kbd>RET</kbd> all the usual Emacs
editing commands are available to correct it (see <a href="emacs.html#Basic">Basic</a>). 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.
<p>ESS provides some other commands which are useful for fixing mistakes:
<ul>
<li><kbd>C-c C-w</kbd> (<code>backward-kill-word</code>) <br>
<a name="index-backward_002dkill_002dword-37"></a>Deletes the previous word (such as an object name) on the command line.
<li><kbd>C-c C-u</kbd> (<code>comint-kill-input</code>) <br>
<a name="index-comint_002dkill_002dinput-38"></a>Deletes everything from the prompt to point. Use this to abandon a
command you have not yet sent to the ESS process.
<li><kbd>C-c C-a</kbd> (<code>comint-bol</code>) <br>
<a name="index-comint_002dbol-39"></a>Move to the beginning of the line, and then skip forwards past the
prompt, if any.
</ul>
<p>Siehe <a href="emacs.html#Shell-Mode">Shell Mode</a>, for other
commands relevant to entering input.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Completion"></a>
nächstes: <a rel="next" accesskey="n" href="#Completion-details">Completion details</a>,
voriges: <a rel="previous" accesskey="p" href="#Command_002dline-editing">Command-line editing</a>,
aufwärts: <a rel="up" accesskey="u" href="#Entering-commands">Entering commands</a>
</div>
<h3 class="section">4.2 Completion of object names</h3>
<p><a name="index-completion-of-object-names-40"></a><a name="index-command_002dline-completion-41"></a>
In the process buffer, the <TAB> key is for completion, similar to
that provided by Shell Mode for filenames. In Inferior S mode,
pressing the <TAB> key when the cursor is following the first few
characters of an object name <em>completes</em> the object name; if the
cursor is following a file name <kbd>TAB</kbd> completes the file name.
<ul>
<li><kbd>TAB</kbd> (<code>comint-dynamic-complete</code>) <br>
<a name="index-comint_002ddynamic_002dcomplete-42"></a>Complete the S object name or filename before point.
</ul>
<p>When the cursor is just after a partially-completed object name,
pressing <TAB> provides completion in a similar fashion to
<code>tcsh</code>
<a name="index-tcsh-43"></a>except that completion is performed over all known S object names
instead of file names. ESS maintains a list of all objects known to S
at any given time, which basically consists of all objects (functions
and datasets) in every attached directory listed by the <code>search()</code>
command
<a name="index-search_0028_0029-44"></a>along with the component objects of attached data frames
<a name="index-data-frames-45"></a>(if your version of S supports them).
<p>For example, consider the three functions (available in Splus version
3.0) called <code>binomplot()</code>, <code>binom.test()</code> and
<code>binomial()</code>. Typing <kbd>bin TAB</kbd> after the S prompt will
insert the characters `<samp><span class="samp">om</span></samp>', completing the longest prefix
(`<samp><span class="samp">binom</span></samp>') which distinguishes these three commands. Pressing
<kbd>TAB</kbd> once more provides a list of the three commands which have
this prefix, allowing you to add more characters (say, `<samp><span class="samp">.</span></samp>') which
specify the function you desire. After entering more characters
pressing <kbd>TAB</kbd> yet again will complete the object name up to
uniqueness, etc. If you just wish to see what completions exist without
adding any extra characters, type <kbd>M-?</kbd>.
<ul>
<li><kbd>M-?</kbd> (<code>ess-list-object-completions</code>) <br>
<a name="index-ess_002dlist_002dobject_002dcompletions-46"></a>List all possible completions of the object name at point.
</ul>
<p>ESS also provides completion over the components of named lists accessed
using the `<samp><span class="samp">$</span></samp>' 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 `<samp><span class="samp">$</span></samp>' and press <kbd>TAB</kbd> to see the names of existing list
components for that object.
<a name="index-lists_002c-completion-on-47"></a><a name="index-completion-on-lists-48"></a>
<a name="index-completion-on-file-names-49"></a>Completion is also provided over file names, which is particularly
useful when using S functions such as <code>get()</code> or <code>scan()</code>
which require fully expanded file names. Whenever the cursor is within
an S string, pressing <kbd>TAB</kbd> completes the file name before
point, and also expands any `<samp><span class="samp">~</span></samp>' or environment variable references.
<p>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.
Siehe <a href="#History-expansion">History expansion</a>.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Completion-details"></a>
nächstes: <a rel="next" accesskey="n" href="#Transcript">Transcript</a>,
voriges: <a rel="previous" accesskey="p" href="#Completion">Completion</a>,
aufwärts: <a rel="up" accesskey="u" href="#Entering-commands">Entering commands</a>
</div>
<h3 class="section">4.3 Completion details</h3>
<p>ESS automatically keeps track of any objects added or deleted to the
system (such as new objects created, or directories added to the search
list) to make completion as accurate as possible. Whenever ESS notices
that search list has changed
<a name="index-ess_002dchange_002dsp_002dregexp-50"></a><a rel="footnote" href="#fn-2" name="fnd-2"><sup>2</sup></a> when you attach a directory or data
frame, the objects associated with it immediately become available for a
completion; when it is detached completion is no longer available on
those objects.
<p>To maintain a list of accessible objects for completion, ESS needs to
determine which objects are contained in each directory or data frame on
the search list. This is done at the start of each S session, by
running the <code>objects()</code> command on every element of the search
list.
<!-- On some systems, however, this can be rather slow; it's doubly -->
<!-- frustrating when you consider that most of the directories on the search -->
<!-- list are the standard @Sl{} libraries, which never change anyway! When -->
<!-- ESS was installed, a database of the standard object names should have -->
<!-- been created which should speed up this process at the start of an S -->
<!-- session; if it has not been created you will get a warning like -->
<!-- `S-namedb.el does not exist'. @xref{Installation}, for information on -->
<!-- how to create this database. -->
<p>Efficiency in completion is gained by maintaining a cache of objects
currently known to S; when a new object becomes available or is deleted,
only one component of the cache corresponding to the associated
directory needs to be refreshed. If ESS ever becomes confused about
what objects are available for completion (such as when if refuses to
complete an object you <strong>know</strong> is there), the command <kbd>M-x
ess-resynch</kbd>
<a name="index-ess_002dresynch-51"></a>forces the <em>entire</em> cache to be refreshed, which should fix the
problem.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Transcript"></a>
nächstes: <a rel="next" accesskey="n" href="#Command-History">Command History</a>,
voriges: <a rel="previous" accesskey="p" href="#Completion-details">Completion details</a>,
aufwärts: <a rel="up" accesskey="u" href="#Entering-commands">Entering commands</a>
</div>
<h3 class="section">4.4 Manipulating the transcript</h3>
<p>Most of the time, the cursor spends most of its time at the bottom of
the ESS process buffer, entering commands. However all the input
and output from the current (and previous) ESS sessions is stored in
the process buffer (we call this the transcript) and often we want to
<a name="index-transcript-52"></a>move back up through the buffer, to look at the output from previous
commands for example.
<p>Within the process buffer, a paragraph
<a name="index-paragraphs-in-the-process-buffer-53"></a>is defined as the prompt, the command after the prompt, and the output
from the command. Thus <kbd>M-{</kbd> and <kbd>M-}</kbd> move you backwards and
forwards, respectively, through commands in the transcript. A
particularly useful command is <kbd>M-h</kbd> (<code>mark-paragraph</code>) which
will allow you to mark a command and its entire output (for deletion,
perhaps). For more information about paragraph commands,
see <a href="emacs.html#Paragraphs">Paragraphs</a>.
<p>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 (`<samp><span class="samp">^L</span></samp>')
character. Thus pages in the ESS
<a name="index-pages-in-the-process-buffer-54"></a>process buffer correspond to ESS sessions. Thus, for example, you may
use <kbd>C-x [</kbd> and <kbd>C-x ]</kbd> to move backward and forwards through
ESS sessions in a single ESS process buffer. For more information about
page commands, see <a href="emacs.html#Pages">Pages</a>.
<ul class="menu">
<li><a accesskey="1" href="#Last-command">Last command</a>: Manipulating the output from the last command
<li><a accesskey="2" href="#Process-buffer-motion">Process buffer motion</a>: Viewing older commands
<li><a accesskey="3" href="#Transcript-resubmit">Transcript resubmit</a>: Re-submitting commands from the transcript
<li><a accesskey="4" href="#Saving-transcripts">Saving transcripts</a>: Keeping a record of your S session
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Last-command"></a>
nächstes: <a rel="next" accesskey="n" href="#Process-buffer-motion">Process buffer motion</a>,
voriges: <a rel="previous" accesskey="p" href="#Transcript">Transcript</a>,
aufwärts: <a rel="up" accesskey="u" href="#Transcript">Transcript</a>
</div>
<h4 class="subsection">4.4.1 Manipulating the output from the last command</h4>
<p>Viewing the output of the command you have just entered is a common
occurrence and ESS provides a number of facilities for doing this.
<!-- Within the ESS process buffer, the variable @code{scroll-step} -->
<!-- @vindex scroll-step -->
<!-- is set to 4 (you can redefine this using @code{inferior-ess-mode-hook} -->
<!-- @vindex inferior-ess-hook -->
<!-- if you wish - @pxref{Hooks},) so that the cursor is usually near the -->
<!-- bottom of the window. -->
Whenever a command produces a longish output, it is possible that the
window will scroll, leaving the next prompt near the middle of the
window. The first part of the command output may have scrolled off the
top of the window, even though the entire output would fit in the window
if the prompt were near the bottom of the window. If this happens, you
can use the command
<ul>
<li><kbd>C-c C-e</kbd> (<code>comint-show-maximum-output</code>) <br>
<a name="index-comint_002dshow_002dmaximum_002doutput-55"></a>Move to the end of the buffer, and place cursor on bottom line of
window.
</ul>
<p class="noindent">to make more of the last output visible. (To make this happen
automatically for all inputs, set the variable
<code>comint-scroll-to-bottom-on-input</code> to <code>t</code>.)
<p>If the first part of the output is still obscured, use
<a name="index-reading-long-command-outputs-56"></a>
<ul>
<li><kbd>C-c C-r</kbd> (<code>comint-show-output</code>) <br>
<a name="index-comint_002dshow_002doutput-57"></a>Moves cursor to the previous command line and and places it at the top
of the window.
</ul>
<p class="noindent">to view it. Finally, if you want to discard the last command output
altogether, use
<ul>
<li><kbd>C-c C-o</kbd> (<code>comint-kill-output</code>) <br>
<a name="index-comint_002dkill_002doutput-58"></a><a name="index-deleting-output-59"></a>Deletes everything from the last command to the current prompt.
</ul>
<p class="noindent">to delete it. Use this command judiciously to keep your transcript to a
more manageable size.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Process-buffer-motion"></a>
nächstes: <a rel="next" accesskey="n" href="#Transcript-resubmit">Transcript resubmit</a>,
voriges: <a rel="previous" accesskey="p" href="#Last-command">Last command</a>,
aufwärts: <a rel="up" accesskey="u" href="#Transcript">Transcript</a>
</div>
<h4 class="subsection">4.4.2 Viewing older commands</h4>
<p>If you want to view the output from more historic commands than the
previous command, commands are also provided to move backwards and
forwards through previously entered commands in the process buffer:
<ul>
<li><kbd>C-c C-p</kbd> (<code>comint-previous-input</code>) <br>
<a name="index-comint_002dprevious_002dinput-60"></a>Moves point to the preceding command in the process buffer.
<li><kbd>C-c C-n</kbd> (<code>comint-next-input</code>) <br>
<a name="index-comint_002dnext_002dinput-61"></a>Moves point to the next command in the process buffer.
</ul>
<p class="noindent">Note that these two commands are analogous to <kbd>C-p</kbd> and <kbd>C-n</kbd>
but apply to command lines rather than text lines. And just like
<kbd>C-p</kbd> and <kbd>C-n</kbd>, passing a prefix argument to these commands
means to move to the <var>ARG</var>'th next (or previous) command. (These
commands are also discussed in <a href="emacs.html#Shell-History-Copying">Shell History Copying</a>.)
<p>There are also two similar commands (not bound to any keys by default)
which move to preceding or succeeding commands, but which first prompt
for a regular expression (see <a href="emacs.html#Regexps">Syntax of Regular Expression</a>), and then moves to
the next (previous) command matching the pattern.
<ul>
<li><code>(comint-backward-matching-input regexp arg)</code> <br>
<a name="index-comint_002dbackward_002dmatching_002dinput-62"></a><code>(comint-forward-matching-input regexp arg)</code> <br>
<a name="index-comint_002dforward_002dmatching_002dinput-63"></a>Search backward (forward) through the transcript buffer for the
<var>arg</var>'th previous (next) command matching <var>regexp</var>. <var>arg</var>
is the prefix argument; <var>regexp</var> is prompted for in the minibuffer.
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Transcript-resubmit"></a>
nächstes: <a rel="next" accesskey="n" href="#Saving-transcripts">Saving transcripts</a>,
voriges: <a rel="previous" accesskey="p" href="#Process-buffer-motion">Process buffer motion</a>,
aufwärts: <a rel="up" accesskey="u" href="#Transcript">Transcript</a>
</div>
<h4 class="subsection">4.4.3 Re-submitting commands from the transcript</h4>
<p>When moving through the transcript, you may wish to re-execute some of
the commands you find there. ESS provides three commands to do this;
these commands may be used whenever the cursor is within a command line
in the transcript (if the cursor is within some command <em>output</em>,
an error is signaled). Note all three commands involve the <RETURN>
key.
<ul>
<li><kbd>RET</kbd> (<code>inferior-ess-send-input</code>) <br>
<a name="index-inferior_002dess_002dsend_002dinput-64"></a>Copy the command under the cursor to the current command line, and
execute it.
<li><kbd>C-c RET</kbd> (<code>comint-copy-old-input</code>) <br>
<a name="index-comint_002dcopy_002dold_002dinput-65"></a>Copy the command under the cursor to the current command line, but don't
execute it. Leaves the cursor on the command line so that the copied
command may be edited.
<li><kbd>M-RET</kbd> (<code>ess-transcript-send-command-and-move</code>) <br>
<a name="index-ess_002dtranscript_002dsend_002dcommand_002dand_002dmove-66"></a>Copy the command under the cursor to the current command line, and
execute it. Moves the cursor to the following command.
</ul>
<p>When the cursor is not after the current prompt, the <RETURN> key
has a slightly different behavior than usual. Pressing <kbd>RET</kbd> on any
line containing a command that you entered (i.e. a line beginning with a
prompt) sends that command to the ESS process once again. If you
wish to edit the command before executing it, use <kbd>C-c RET</kbd> instead;
it copies the command to the current prompt but does not execute it,
allowing you to edit it before submitting it.
<p>These two commands leave the cursor at the new command line, allowing
you to continue with interactive use of S. If you wish to resubmit a
series of commands from the transcript, consider using <kbd>M-RET</kbd>
instead, which leaves the cursor at the command line following the one
you re-submitted. Thus by using <kbd>M-RET</kbd> repeatedly, you can
re-submit a whole series of commands.
<p>These commands work even if if the current line is a continuation line
(i.e. the prompt is `<samp><span class="samp">+</span></samp>' instead of `<samp><span class="samp">></span></samp>') — in this case all
the lines that form the multi-line command are concatenated together and
the resulting command is sent to the ESS process (currently this is
the only way to resubmit a multi-line command to the ESS process in
one go). If the current line does
<a name="index-multi_002dline-commands_002c-resubmitting-67"></a>not begin with a prompt, an error is signaled. This feature, coupled
with the command-based motion commands described above, could be used as
a primitive history mechanism. ESS provides a more sophisticated
mechanism, however, which is described in <a href="#Command-History">Command History</a>.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Saving-transcripts"></a>
voriges: <a rel="previous" accesskey="p" href="#Transcript-resubmit">Transcript resubmit</a>,
aufwärts: <a rel="up" accesskey="u" href="#Transcript">Transcript</a>
</div>
<h4 class="subsection">4.4.4 Keeping a record of your S session</h4>
<p>To keep a record of your S session in a disk file, use the Emacs
command <kbd>C-x C-w</kbd> (<code>write-file</code>) to attach a file to the
ESS process buffer. The name of the process buffer will (probably)
change to the name of the file, but this is not a problem. You can
still use S as usual; just remember to save the file before you quit
Emacs with <kbd>C-x C-s</kbd>. You can make ESS prompt you for a filename in
which to save the transcript every time you start S by setting the
variable
<a name="index-ess_002dask_002dabout_002dtransfile-68"></a><code>ess-ask-about-transfile</code> to <code>t</code>; see <a href="#Customizing-startup">Customizing startup</a>.
<a name="index-transcript-file-names-69"></a>We recommend you save your transcripts with filenames that end in
`<samp><span class="samp">.St</span></samp>'. There is a special mode (ESS transcript mode —
see <a href="#Transcript-Mode">Transcript Mode</a>) for editing transcript files which is
automatically selected for files with this suffix.
<p><a name="index-editing-transcripts-70"></a>S transcripts can get very large, so some judicious editing is
appropriate if you are saving it in a file. Use <kbd>C-c C-o</kbd> whenever
a command produces excessively long output (printing large arrays, for
example). Delete erroneous commands (and the resulting error messages
or other output) by moving to the command (or its output) and typing
<kbd>M-h C-w</kbd>. Also, remember that <kbd>C-c C-e</kbd> (and other hot keys)
may be used for commands whose output you do not wish to appear in the
transcript. These suggestions are appropriate even if you are not
saving your transcript to disk, since the larger the transcript, the
more memory your Emacs process will use on the host machine.
<p>Finally, if you intend to produce S source code (suitable for using
with <code>source()</code> or inclusion in an S function) from a
transcript, then the command <kbd>M-x ess-transcript-clean-region</kbd> may
be of use.
<a name="index-ess_002dtranscript_002dclean_002dregion-71"></a>This command works in any Emacs buffer, and removes all prompts and
command output from an ESS transcript within the current region, leaving
only the commands. Don't forget to remove any erroneous commands first!
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Command-History"></a>
nächstes: <a rel="next" accesskey="n" href="#History-expansion">History expansion</a>,
voriges: <a rel="previous" accesskey="p" href="#Transcript">Transcript</a>,
aufwärts: <a rel="up" accesskey="u" href="#Entering-commands">Entering commands</a>
</div>
<h3 class="section">4.5 Command History</h3>
<p><a name="index-command-history-72"></a><a name="index-editing-commands-73"></a><a name="index-re_002dexecuting-commands-74"></a>
ESS provides easy-to-use facilities for re-executing or editing previous
commands. An input history of the last few commands is maintained (by
default the last 50 commands are stored, although this can be changed by
setting the variable <code>comint-input-ring-size</code> in
<a name="index-comint_002dinput_002dring_002dsize-75"></a><code>inferior-ess-mode-hook</code>.) The simplest history commands simply
select the next and previous commands in the input history:
<ul>
<li><kbd>M-p</kbd> (<code>comint-previous-input</code>) <br>
<a name="index-comint_002dprevious_002dinput-76"></a>Select the previous command in the input history.
<li><kbd>M-n</kbd> (<code>comint-next-input</code>) <br>
<a name="index-comint_002dnext_002dinput-77"></a>Select the next command in the input history.
</ul>
<p class="noindent">For example, pressing <kbd>M-p</kbd> once will re-enter the last command into
the process buffer after the prompt but does not send it to the ESS
process, thus allowing editing or correction of the command before the
ESS process sees it. Once corrections have been made, press
<kbd>RET</kbd> to send the edited command to the ESS process.
<p>If you want to select a particular command from the history by matching
it against a regular expression (see <a href="emacs.html#Regexps">Syntax of Regular Expression</a>), to search for a
particular variable name for example, these commands are also available:
<ul>
<li><kbd>M-r</kbd> (<code>comint-previous-matching-input</code>) <br>
<a name="index-comint_002dprevious_002dmatching_002dinput-78"></a>Prompt for a regular expression, and search backwards through the input
history for a command matching the expression.
<li><kbd>M-s</kbd> (<code>comint-next-matching-input</code>) <br>
<a name="index-comint_002dnext_002dmatching_002dinput-79"></a>Prompt for a regular expression, and search backwards through the input
history for a command matching the expression.
</ul>
<p class="noindent">A common type of search is to find the last command that began with a
particular sequence of characters; the following two commands provide an
easy way to do this:
<ul>
<li><kbd>A-M-r</kbd> (<code>comint-previous-matching-input-from-input</code>) <br>
<a name="index-comint_002dprevious_002dmatching_002dinput_002dfrom_002dinput-80"></a>Select the previous command in the history which matches the string
typed so far.
<li><kbd>A-M-s</kbd> (<code>comint-next-matching-input-from-input</code>) <br>
<a name="index-comint_002dnext_002dmatching_002dinput_002dfrom_002dinput-81"></a>Select the next command in the history which matches the string typed so
far.
</ul>
<p class="noindent">Instead of prompting for a regular expression to match against, as they
instead select commands starting with those characters already entered.
For instance, if you wanted to re-execute the last <code>attach()</code>
command, you may only need to type <kbd>att</kbd> and then <kbd>A-M-r</kbd> and
<kbd>RET</kbd>. (Note: you may not have an <ALT> key on your keyboard,
in which case it may be a good idea to bind these commands to some other
keys.)
<p>Siehe <a href="emacs.html#Shell-Ring">Shell History Ring</a>, for a more detailed discussion of the history mechanism.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="History-expansion"></a>
nächstes: <a rel="next" accesskey="n" href="#Hot-keys">Hot keys</a>,
voriges: <a rel="previous" accesskey="p" href="#Command-History">Command History</a>,
aufwärts: <a rel="up" accesskey="u" href="#Entering-commands">Entering commands</a>
</div>
<h3 class="section">4.6 References to historical commands</h3>
<p>Instead of searching through the command history using the command
described in the previous section, you can alternatively refer to a
historical command directly using a notation very similar to that used
in <code>csh</code>. History references are introduced by a `<samp><span class="samp">!</span></samp>' or
`<samp><span class="samp">^</span></samp>' character and have meanings as follows:
<dl>
<dt>`<samp><span class="samp">!!</span></samp>'<dd>The immediately previous command
<br><dt>`<samp><span class="samp">!-</span><var>N</var></samp>'<dd>The <var>N</var>th previous command
<br><dt>`<samp><span class="samp">!text</span></samp>'<dd>The last command beginning with the string `<samp><span class="samp">text</span></samp>'
<br><dt>`<samp><span class="samp">!?text</span></samp>'<dd>The last command containing the string `<samp><span class="samp">text</span></samp>'
</dl>
<p>In addition, you may follow the reference with a <dfn>word designator</dfn>
to select particular <dfn>words</dfn> of the input. A word is defined as a
sequence of characters separated by whitespace. (You can modify this
definition by setting the value of <code>comint-delimiter-argument-list</code>
to a list of characters that are allowed to separate words and
<a name="index-comint_002ddelimiter_002dargument_002dlist-82"></a>themselves form words.) Words are numbered beginning with zero. The
word designator usually begins with a `<samp><span class="samp">:</span></samp>' (colon) character;
however it may be omitted if the word reference begins with a `<samp><span class="samp">^</span></samp>',
`<samp><span class="samp">$</span></samp>', `<samp><span class="samp">*</span></samp>' or `<samp><span class="samp">-</span></samp>'. If the word is to be selected from the
previous command, the second `<samp><span class="samp">!</span></samp>' character can be omitted from the
event specification. For instance, `<samp><span class="samp">!!:1</span></samp>' and `<samp><span class="samp">!:1</span></samp>' both
refer to the first word of the previous command, while `<samp><span class="samp">!!$</span></samp>' and
`<samp><span class="samp">!$</span></samp>' both refer to the last word in the previous command. The
format of word designators is as follows:
<dl>
<dt>`<samp><span class="samp">0</span></samp>'<dd>The zeroth word (i.e. the first one on the command line)
<br><dt>`<samp><var>n</var></samp>'<dd>The <var>n</var>th word, where <var>n</var> is a number
<br><dt>`<samp><span class="samp">^</span></samp>'<dd>The first word (i.e. the second one on the command line)
<br><dt>`<samp><span class="samp">$</span></samp>'<dd>The last word
<br><dt>`<samp><var>x</var><span class="samp">-</span><var>y</var></samp>'<dd>A range of words; `<samp><span class="samp">-</span><var>y</var></samp>' abbreviates `<samp><span class="samp">0-</span><var>y</var></samp>'
<br><dt>`<samp><span class="samp">*</span></samp>'<dd>All the words except the zeroth word, or nothing if the command had just
one word (the zeroth)
<br><dt>`<samp><var>x</var><span class="samp">*</span></samp>'<dd>Abbreviates <var>x</var>-$
<br><dt>`<samp><var>x</var><span class="samp">-</span></samp>'<dd>Like `<samp><var>x</var><span class="samp">*</span></samp>', but omitting the last word
</dl>
<p>In addition, you may surround the entire reference except for the first
`<samp><span class="samp">!</span></samp>' by braces to allow it to be followed by other (non-whitespace)
characters (which will be appended to the expanded reference).
<p>Finally, ESS also provides quick substitution; a reference like
`<samp><span class="samp">^old^new^</span></samp>' means “the last command, but with the first occurrence
of the string `<samp><span class="samp">old</span></samp>' replaced with the string `<samp><span class="samp">new</span></samp>'” (the last
`<samp><span class="samp">^</span></samp>' is optional). Similarly, `<samp><span class="samp">^old^</span></samp>' means “the last
command, with the first occurrence of the string `<samp><span class="samp">old</span></samp>' deleted”
(again, the last `<samp><span class="samp">^</span></samp>' is optional).
<p>To convert a history reference as described above to an input suitable
for S, you need to <dfn>expand</dfn> the history reference, using the
<TAB> key. For this to work, the cursor must be preceded by a space
(otherwise it would try to complete an object name) and not be within a
string (otherwise it would try to complete a filename). So to expand
the history reference, type <kbd>SPC TAB</kbd>. This will convert the
history reference into an S command from the history, which you can
then edit or press <RET> to execute.
<p>For example, to execute the last command that referenced the variable
<code>data</code>, type <kbd>!?data SPC TAB RET</kbd>.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Hot-keys"></a>
nächstes: <a rel="next" accesskey="n" href="#Statistical-Process-running-in-ESS_003f">Statistical Process running in ESS?</a>,
voriges: <a rel="previous" accesskey="p" href="#History-expansion">History expansion</a>,
aufwärts: <a rel="up" accesskey="u" href="#Entering-commands">Entering commands</a>
</div>
<h3 class="section">4.7 Hot keys for common commands</h3>
<p>ESS provides a number of commands for executing the commonly used
functions. These commands below are basically information-gaining
commands (such as <code>objects()</code> or <code>search()</code>) which tend to
clutter up your transcript and for this reason some of the hot keys
display their output in a temporary buffer instead of the process buffer
by default. This behavior is controlled by the variable
<code>ess-execute-in-process-buffer</code> which, if
<a name="index-ess_002dexecute_002din_002dprocess_002dbuffer-83"></a>non-<code>nil</code>, means that these commands will produce their output in
the process buffer instead. In any case, passing a prefix argument to
the commands (with <kbd>C-u</kbd>) will reverse the meaning of
<code>ess-execute-in-process-buffer</code> for that command, i.e. the output
will be displayed in the process buffer if it usually goes to a
temporary buffer, and vice-versa. These are the hot keys that behave in
this way:
<ul>
<li><kbd>C-c C-x</kbd> (<code>ess-execute-objects</code>) <br>
<a name="index-ess_002dexecute_002dobjects-84"></a>Sends the <code>objects()</code>
<a name="index-objects_0028_0029-85"></a>command to the ESS process. A prefix argument specifies the
position on the search list (use a negative argument to toggle
<code>ess-execute-in-process-buffer</code> as well). A quick way to see what
objects are in your working directory.
<a name="index-objects-86"></a><a name="index-objects_0028_0029-87"></a>
<li><kbd>C-c C-s</kbd> (<code>ess-execute-search</code>) <br>
<a name="index-ess_002dexecute_002dsearch-88"></a>Sends the <code>search()</code>
<a name="index-search_0028_0029-89"></a>command to the ESS process.
<a name="index-search-list-90"></a><a name="index-search_0028_0029-91"></a>
<li><kbd>C-c C-e</kbd> (<code>ess-execute</code>) <br>
<a name="index-ess_002dexecute-92"></a>Prompt for an ESS expression, and evaluate it.
</ul>
<p><code>ess-execute</code> may seem pointless when you could just type the
command in anyway, but it proves useful for `spot' calculations which
would otherwise clutter your transcript, or for evaluating an expression
while partway through entering a command. You can also use this command
to generate new hot keys using the Emacs keyboard macro facilities;
see <a href="emacs.html#Keyboard-Macros">Keyboard Macros</a>.
<a name="index-hot-keys-93"></a><a name="index-keyboard-short-cuts-94"></a>
The following hot keys do not use <code>ess-execute-in-process-buffer</code>
to decide where to display the output — they either always display in
the process buffer or in a separate buffer, as indicated:
<ul>
<li><kbd>C-c C-a</kbd> (<code>ess-execute-attach</code>) <br>
<a name="index-ess_002dexecute_002dattach-95"></a>Prompts for a directory to attach to the ESS process with the
<code>attach()</code> command.
<a name="index-attach_0028_0029-96"></a>If a numeric prefix argument is given it is used as the position on the
search list to attach the directory; otherwise the S default of 2 is
used. The <code>attach()</code> command actually executed appears in the
process buffer.
<li><kbd>C-c C-l</kbd> (<code>ess-load-file</code>) <br>
<a name="index-ess_002dload_002dfile-97"></a>Prompts for a file to load into the ESS process using
<code>source()</code>. If there is an error during loading, you can jump to
the error in the file with <kbd>C-x `</kbd> (<code>ess-parse-errors</code>).
<a name="index-ess_002dparse_002derrors-98"></a>Siehe <a href="#Error-Checking">Error Checking</a>, for more details.
<li><kbd>C-c C-v</kbd> (<code>ess-display-help-on-object</code>) <br> Pops up a help
buffer for an S object or function. See <a href="#Help">Help</a> for more
details.
<li><kbd>C-c C-q</kbd> (<code>ess-quit</code>) <br>
<a name="index-quitting-from-ESS-99"></a><a name="index-killing-the-ESS-process-100"></a>Sends the <code>q()</code>
<a name="index-q_0028_0029-101"></a>command to the ESS process (or <code>(exit)</code>
<a name="index-exit_0028_0029-102"></a>to the <b>XLS</b> process), and cleans up any temporary buffers (such as
help buffers or edit buffers) you may have created along the way. Use
this command when you have finished your S session instead of simply
typing <code>q()</code> yourself, otherwise you will need to issue the command
<kbd>M-x ess-cleanup</kbd>
<a name="index-ess_002dcleanup-103"></a><a name="index-cleaning-up-104"></a><a name="index-temporary-buffers_002c-killing-105"></a><a name="index-killing-temporary-buffers-106"></a>command explicitly to make sure that all the files that need to be saved
have been saved, and that all the temporary buffers have been killed.
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Statistical-Process-running-in-ESS%3f"></a>
<a name="Statistical-Process-running-in-ESS_003f"></a>
nächstes: <a rel="next" accesskey="n" href="#Emacsclient">Emacsclient</a>,
voriges: <a rel="previous" accesskey="p" href="#Hot-keys">Hot keys</a>,
aufwärts: <a rel="up" accesskey="u" href="#Entering-commands">Entering commands</a>
</div>
<h3 class="section">4.8 Is the Statistical Process running under ESS?</h3>
<p><a name="index-STERM-107"></a><a name="index-STERM-108"></a>For the S languages (S, S-Plus, R) ESS sets an option in the current
process that programs in the language can check to determine the
environment in which they are currently running.
<p>ESS sets
<code>options(STERM="iESS")</code> for S language processes running in an
inferior <code>iESS[S]</code> or <code>iESS[R]</code> buffer.
<p>ESS sets
<code>options(STERM="ddeESS")</code> for independent S-Plus for Windows
processes running in the GUI and communicating with ESS via
the DDE (Microsoft Dynamic Data Exchange) protocol through a
<code>ddeESS[S]</code> buffer.
<p>Other values of <code>options()$STERM</code> that we recommend are:
<ul>
<li><code>length</code>: Fixed length xterm or telnet window.
<li><code>scrollable</code>: Unlimited length xterm or telnet window.
<li><code>server</code>: S-Plus Stat Server.
<li><code>BATCH</code>: BATCH.
<li><code>Rgui</code>: R GUI.
<li><code>Commands</code>: S-Plus GUI without DDE interface to ESS.
</ul>
<p>Additional values may be recommended in the future as new interaction
protocols are created. Unlike the values <code>iESS</code> and <code>ddeESS</code>,
ESS can't set these other values since the S language program is not
under the control of ESS.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Emacsclient"></a>
nächstes: <a rel="next" accesskey="n" href="#Other">Other</a>,
voriges: <a rel="previous" accesskey="p" href="#Statistical-Process-running-in-ESS_003f">Statistical Process running in ESS?</a>,
aufwärts: <a rel="up" accesskey="u" href="#Entering-commands">Entering commands</a>
</div>
<h3 class="section">4.9 Using emacsclient</h3>
<p><a name="index-emacsclient-109"></a>
When starting R or S under Unix, ESS sets
<code>options(editor="emacsclient")</code>. (Under Microsoft Windows, it will
use gnuclient.exe rather than emacsclient, but the same principle
applies.) Within your R session, for example, if you have a function
called <code>iterator</code>, typing <code>fix(iterator)</code>, will show that
function in a temporary Emacs buffer. You can then correct the
function. When you kill the buffer, the definition of the function is
updated. Using <code>edit()</code> rather than <code>fix()</code> means that the
function is not updated. Finally, the S function <code>page(x)</code> will
also show a text representation of the object <code>x</code> in a temporary
Emacs buffer.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Other"></a>
voriges: <a rel="previous" accesskey="p" href="#Emacsclient">Emacsclient</a>,
aufwärts: <a rel="up" accesskey="u" href="#Entering-commands">Entering commands</a>
</div>
<h3 class="section">4.10 Other commands provided by inferior-ESS</h3>
<p>The following commands are also provided in the process buffer:
<ul>
<li><kbd>C-c C-c</kbd> (<code>comint-interrupt-subjob</code>) <br>
<a name="index-comint_002dinterrupt_002dsubjob-110"></a>Sends a Control-C signal to the ESS process. This has the effect of
<a name="index-aborting-S-commands-111"></a><a name="index-interrupting-S-commands-112"></a>aborting the current command.
<li><kbd>C-c C-z</kbd> (<code>ess-abort</code>) <br>
<a name="index-ess_002dabort-113"></a><a name="index-comint_002dstop_002dsubjob-114"></a>Sends a STOP signal to the ESS process, killing it immediately.
It's not a good idea to use this, in general: Neither <code>q()</code> nor
<code>.Last</code> will be executed and device drivers will not finish
cleanly. This command is provided as a safety to
<code>comint-stop-subjob</code>, which is usually bound to <kbd>C-c C-z</kbd>. If
you want to quit from S, use <kbd>C-c C-q</kbd> (<code>ess-quit</code>) instead.
<a name="index-ess_002dquit-115"></a><a name="index-aborting-the-ESS-process-116"></a>
<li><kbd>C-c C-d</kbd> (<code>ess-dump-object-into-edit-buffer</code>) <br>
<a name="index-ess_002ddump_002dobject_002dinto_002dedit_002dbuffer-117"></a>Prompts for an object to be edited in an edit buffer. Siehe <a href="#Editing">Editing</a>.
</ul>
<p>Other commands available in Inferior S mode are discussed in
<a href="emacs.html#Shell-Mode">Shell Mode</a>.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Transcript-Mode"></a>
nächstes: <a rel="next" accesskey="n" href="#ESS-for-the-S-family">ESS for the S family</a>,
voriges: <a rel="previous" accesskey="p" href="#Entering-commands">Entering commands</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">5 Manipulating saved transcript files</h2>
<p>Inferior S mode records the transcript (the list of all commands
executed, and their output) in the process buffer, which can be saved as
a <dfn>transcript file</dfn>, which should normally have the suffix
<samp><span class="file">.St</span></samp>. The most obvious use for a transcript file is as a static
record of the actions you have performed in a particular S session.
Sometimes, however, you may wish to re-execute commands recorded in the
transcript file by submitting them to a running ESS process. This
is what Transcript Mode is for.
<p>If you load file a with the suffix <samp><span class="file">.St</span></samp> into Emacs, it is placed
in S Transcript Mode. Transcript Mode is similar to Inferior S mode
(see <a href="#Entering-commands">Entering commands</a>):
<a name="index-transcript-mode-motion-118"></a><a name="index-motion-in-transcript-mode-119"></a>paragraphs are defined as a command and its output, and you can move
though commands either with the paragraph commands or with <kbd>C-c C-p</kbd>
and <kbd>C-c C-n</kbd>.
<ul class="menu">
<li><a accesskey="1" href="#Resubmit">Resubmit</a>: Resubmitting commands from the transcript file
<li><a accesskey="2" href="#Clean">Clean</a>: Cleaning transcript files
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Resubmit"></a>
nächstes: <a rel="next" accesskey="n" href="#Clean">Clean</a>,
voriges: <a rel="previous" accesskey="p" href="#Transcript-Mode">Transcript Mode</a>,
aufwärts: <a rel="up" accesskey="u" href="#Transcript-Mode">Transcript Mode</a>
</div>
<h3 class="section">5.1 Resubmitting commands from the transcript file</h3>
<p>Three commands are provided to re-submit command lines from the
transcript file to a running ESS process. They are:
<ul>
<li><kbd>RET</kbd> (<code>ess-transcript-send-command</code>) <br>
Send the current command line to the ESS process, and execute it.
<a name="index-ess_002dtranscript_002dsend_002dcommand-120"></a>
<li><kbd>C-c RET</kbd> (<code>ess-transcript-copy-command</code>) <br>
Copy the current command to the ESS process, and switch to the
ESS process buffer (ready to edit the copied command).
<a name="index-ess_002dtranscript_002dcopy_002dcommand-121"></a>
<li><kbd>M-RET</kbd> (<code>ess-transcript-send-command-and-move</code>) <br>
Send the current command to the ESS process, and move to the next
command line. This command is useful for submitting a series of
commands.
</ul>
<p class="noindent">Note that these commands are similar to those on the same keys in
Inferior S Mode. In all three cases, the commands should be
executed when the cursor is on a command line in the transcript; the
prompt is automatically removed before the command is submitted.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Clean"></a>
voriges: <a rel="previous" accesskey="p" href="#Resubmit">Resubmit</a>,
aufwärts: <a rel="up" accesskey="u" href="#Transcript-Mode">Transcript Mode</a>
</div>
<h3 class="section">5.2 Cleaning transcript files</h3>
<p>Yet another use for transcript files is to extract the command lines for
inclusion in an S source file or function. Transcript mode provides
one command which does just this:
<ul>
<li><kbd>C-c C-w</kbd> (<code>ess-transcript-clean-region</code>) <br>
Deletes all prompts and command output in the region, leaving only the
commands themselves.
</ul>
<p class="noindent">The remaining command lines may then be copied to a source file or edit
buffer for inclusion in a function definition, or may be evaluated
directly (see <a href="#Evaluating-code">Evaluating code</a>) using the code evaluation commands
from S mode, also available in S Transcript Mode.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS-for-the-S-family"></a>
nächstes: <a rel="next" accesskey="n" href="#Editing">Editing</a>,
voriges: <a rel="previous" accesskey="p" href="#Transcript-Mode">Transcript Mode</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">6 ESS for the S family</h2>
<ul class="menu">
<li><a accesskey="1" href="#ESS_0028S_0029_002d_002dEditing-files">ESS(S)--Editing files</a>
<li><a accesskey="2" href="#iESS_0028S_0029_002d_002dInferior-ESS-processes">iESS(S)--Inferior ESS processes</a>
<li><a accesskey="3" href="#ESS_002dhelp_002d_002dassistance-with-viewing-help">ESS-help--assistance with viewing help</a>
<li><a accesskey="4" href="#Philosophies-for-using-ESS_0028S_0029">Philosophies for using ESS(S)</a>
<li><a accesskey="5" href="#Scenarios-for-use-_0028possibilities_002d_002dbased-on-actual-usage_0029">Scenarios for use (possibilities--based on actual usage)</a>
<li><a accesskey="6" href="#Customization-Examples-and-Solutions-to-Problems">Customization Examples and Solutions to Problems</a>
</ul>
<div class="node">
<p><hr>
<a name="ESS(S)--Editing-files"></a>
<a name="ESS_0028S_0029_002d_002dEditing-files"></a>
nächstes: <a rel="next" accesskey="n" href="#iESS_0028S_0029_002d_002dInferior-ESS-processes">iESS(S)--Inferior ESS processes</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-the-S-family">ESS for the S family</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">6.1 ESS[S]–Editing files</h3>
<p>ESS[S] is the mode for editing S language files. This mode handles:
<ul>
<li> proper indenting, generated by both [Tab] and [Return].
<li> color and font choices based on syntax.
<li> ability to send the contents of an entire buffer, a highlighted
region, an S function, or a single line to an inferior S process, if
one is currently running.
<li> ability to switch between processes which would be the target of the
buffer (for the above).
<li> The ability to request help from an S process for variables and
functions, and to have the results sent into a separate buffer.
<li> completion of object names and file names.
</ul>
<p>ESS[S] mode should be automatically turned on when loading a file with
the suffices found in ess-site (*.R, *.S, *.s, etc). However, one
will have to start up an inferior process to take advantage of the
interactive features.
<div class="node">
<p><hr>
<a name="iESS(S)--Inferior-ESS-processes"></a>
<a name="iESS_0028S_0029_002d_002dInferior-ESS-processes"></a>
nächstes: <a rel="next" accesskey="n" href="#ESS_002dhelp_002d_002dassistance-with-viewing-help">ESS-help--assistance with viewing help</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS_0028S_0029_002d_002dEditing-files">ESS(S)--Editing files</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-the-S-family">ESS for the S family</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">6.2 iESS[S]–Inferior ESS processes</h3>
<p>iESS (inferior ESS) is the mode for interfacing with active
statistical processes (programs). This mode handles:
<ul>
<li> proper indenting, generated by both [Tab] and [Return].
<li> color and font highlighting based on syntax.
<li> ability to resubmit the contents of a multi-line command
to the executing process with a single keystroke [RET].
<li> The ability to request help from the current process for variables
and functions, and to have the results sent into a separate buffer.
<li> completion of object names and file names.
<li> interactive history mechanism.
<li> transcript recording and editing.
</ul>
<p>To start up iESS mode, use:
<pre class="example"> M-x S+3
M-x S4
M-x S+5
M-x S+6
M-x R
</pre>
<p>(for S-PLUS 3.x, S4, S+5, S+6 or S+7, and R, respectively. This assumes that
you have access to each). Usually the site will have defined one of
these programs (by default S+6) to the simpler name:
<p>M-x S
<p>In the (rare) case that you wish to pass command line arguments to the
starting S+6 process, set the variable <code>inferior-Splus-args</code>.
<p>Note that R has some extremely useful command line arguments. For
example, <code>--vanilla</code> will ensure R starts up without loading in any init
files. To enter a command line argument, call R using a "prefix
argument", by
<p>C-u M-x R
<p>and when ESS prompts for "Starting Args ? ", enter (for example):
<p><code>--vanilla</code>
<p>Then that R process will be started up using <code>R --vanilla</code>. If you
wish to always call R with certain arguments, set the variable
<code>inferior-R-args</code> accordingly.
<!-- Menubar access to other versions of R and Sqpe -->
<p>If you have other versions of R or S-Plus available on the system, ESS
is also able to start those versions. How this works depend on which OS
you are using:
<p>R on Unix systems:
If you have "R-1.8.1" on
your `exec-path', it can be started using <kbd>M-x R-1.8.1</kbd>. By
default, ESS will find versions of R beginning "R-1" or "R-2". If your
versions of R are called other names, consider renaming them with a
symbolic link or change the variable <code>ess-r-versions</code>. To see
which defuns have been created for starting different versions of R,
type <kbd>M-x R-</kbd> and then hit [Tab]. You will then see if any defuns
for particular versions of R have been created. These other versions of
R can also be started from the "ESS->Start Process->Other" menu.
<p>R on Windows systems:
If you have "rw1081" on
your `exec-path', it can be started using <kbd>M-x rw1081</kbd>. By
default, ESS will find versions of R located in directories
parallel to the version of R in your <code>PATH</code>. If your
versions of R are called other names, you will need to change the variable
<code>ess-rterm-versions</code>. To see
which defuns have been created for starting different versions of R,
type <kbd>M-x rw</kbd> and then hit [Tab]. You will then see if any defuns
for particular versions of R have been created. These other versions of
R can also be started from the "ESS->Start Process->Other" menu.
<p>Sqpe (S-Plus running inside an emacs buffer) on Windows systems:
If you have an older version of S-Plus (S-Plus 6.1 for example) on your system,
ir can be started inside an emacs buffer with <kbd>M-x splus61</kbd>. By
default, ESS will find versions of S-Plus located in the installation
directories that Insightful uses by default. If your
versions of S-Plus are anywhere else, you will need to change the variable
<code>ess-SHOME-versions</code>. To see
which defuns have been created for starting different versions of S-Plus,
type <kbd>M-x spl</kbd> and then hit [Tab]. You will then see if any defuns
for particular versions of S-Plus have been created. These other versions of
S-Plus can also be started from the "ESS->Start Process->Other" menu.
<div class="node">
<p><hr>
<a name="ESS-help--assistance-with-viewing-help"></a>
<a name="ESS_002dhelp_002d_002dassistance-with-viewing-help"></a>
nächstes: <a rel="next" accesskey="n" href="#Philosophies-for-using-ESS_0028S_0029">Philosophies for using ESS(S)</a>,
voriges: <a rel="previous" accesskey="p" href="#iESS_0028S_0029_002d_002dInferior-ESS-processes">iESS(S)--Inferior ESS processes</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-the-S-family">ESS for the S family</a>
</div>
<!-- node-name, next, previous, up -->
<h3 class="section">6.3 ESS-help–assistance with viewing help</h3>
<p>ESS has built-in facilities for viewing help files from S. Siehe <a href="#Help">Help</a>.
<div class="node">
<p><hr>
<a name="Philosophies-for-using-ESS(S)"></a>
<a name="Philosophies-for-using-ESS_0028S_0029"></a>
nächstes: <a rel="next" accesskey="n" href="#Scenarios-for-use-_0028possibilities_002d_002dbased-on-actual-usage_0029">Scenarios for use (possibilities--based on actual usage)</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS_002dhelp_002d_002dassistance-with-viewing-help">ESS-help--assistance with viewing help</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-the-S-family">ESS for the S family</a>
</div>
<h3 class="section">6.4 Philosophies for using ESS[S]</h3>
<p>The first is preferred, and configured for. The second one can be
retrieved again, by changing emacs variables.
<p>1: (preferred by the current group of developers): The source code is
real. The objects are realizations of the source code. Source
for EVERY user modified object is placed in a particular directory
or directories, for later editing and retrieval.
<p>2: (older version): S objects are real. Source code is a temporary
realization of the objects. Dumped buffers should not be saved.
_We_strongly_discourage_this_approach_. However, if you insist,
add the following lines to your .emacs file:
<pre class="example"> (setq ess-keep-dump-files 'nil)
(setq ess-delete-dump-files t)
(setq ess-mode-silently-save nil)
</pre>
<p>The second saves a small amount of disk space. The first allows for
better portability as well as external version control for code.
<div class="node">
<p><hr>
<a name="Scenarios-for-use-(possibilities--based-on-actual-usage)"></a>
<a name="Scenarios-for-use-_0028possibilities_002d_002dbased-on-actual-usage_0029"></a>
nächstes: <a rel="next" accesskey="n" href="#Customization-Examples-and-Solutions-to-Problems">Customization Examples and Solutions to Problems</a>,
voriges: <a rel="previous" accesskey="p" href="#Philosophies-for-using-ESS_0028S_0029">Philosophies for using ESS(S)</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-the-S-family">ESS for the S family</a>
</div>
<h3 class="section">6.5 Scenarios for use (possibilities–based on actual usage)</h3>
<p>We present some basic suggestions for using ESS to interact with S.
These are just a subset of approaches, many better approaches are
possible. Contributions of examples of how you work with ESS are
appreciated (especially since it helps us determine priorities on
future enhancements)! (comments as to what should be happening are
prefixed by "##").
<pre class="display"> 1: ## Data Analysis Example (source code is real)
## Load the file you want to work with
C-x C-f myfile.s
## Edit as appropriate, and then start up S-PLUS 3.x
M-x S+3
## A new buffer *S+3:1* will appear. Splus will have been started
## in this buffer. The buffer is in iESS [S+3:1] mode.
## Split the screen and go back to the file editing buffer.
C-x 2 C-x b myfile.s
## Send regions, lines, or the entire file contents to S-PLUS. For regions,
## highlight a region with keystrokes or mouse and then send with:
C-c C-r
## Re-edit myfile.s as necessary to correct any difficulties. Add
## new commands here. Send them to S by region with C-c C-r, or
## one line at a time with C-c C-n.
## Save the revised myfile.s with C-x C-s.
## Save the entire *S+3:1* interaction buffer with C-c C-s. You
## will be prompted for a file name. The recommended name is
## myfile.St. With the *.St suffix, the file will come up in ESS
## Transcript mode the next time it is accessed from Emacs.
2: ## Program revision example (source code is real)
## Start up S-PLUS 3.x in a process buffer (this will be *S+3:1*)
M-x S+3
## Load the file you want to work with
C-x C-f myfile.s
## edit program, functions, and code in myfile.s, and send revised
## functions to S when ready with
C-c C-f
## or highlighted regions with
C-c C-r
## or individual lines with
C-c C-n
## or load the entire buffer with
C-c C-l
## save the revised myfile.s when you have finished
C-c C-s
3: ## Program revision example (S object is real)
## Start up S-PLUS 3.x in a process buffer (this will be *S+3:1*)
M-x S+3
## Dump an existing S object my.function into a buffer to work with
C-c C-d my.function
## a new buffer named yourloginname.my.function.S will be created with
## an editable copy of the object. The buffer is associated with the
## pathname /tmp/yourloginname.my.function.S and will amlost certainly not
## exist after you log off.
## enter program, functions, and code into work buffer, and send
## entire contents to S-PLUS when ready
C-c C-b
## Go to *S+3:1* buffer, which is the process buffer, and examine
## the results.
C-c C-y
## The sequence C-c C-y is a shortcut for: C-x b *S+3:1*
## Return to the work buffer (may/may not be prefixed)
C-x C-b yourloginname.my.function.S
## Fix the function that didn't work, and resubmit by placing the
## cursor somewhere in the function and
C-c C-f
## Or you could've selected a region (using the mouse, or keyboard
## via setting point/mark) and
C-c C-r
## Or you could step through, line by line, using
C-c C-n
## Or just send a single line (without moving to the next) using
C-c C-j
## To fix that error in syntax for the "rchisq" command, get help
## by
C-c C-v rchisq
4: Data Analysis (S object is real)
## Start up S-PLUS 3.x, in a process buffer (this will be *S+3:1*)
M-x S+3
## Work in the process buffer. When you find an object that needs
## to be changed (this could be a data frame, or a variable, or a
## function), dump it to a buffer:
C-c C-d my.cool.function
## Edit the function as appropriate, and dump back in to the
## process buffer
C-c C-b
## Return to the S-PLUS process buffer
C-c C-y
## Continue working.
## When you need help, use
C-c C-v rchisq
## instead of entering: help("rchisq")
</pre>
<div class="node">
<p><hr>
<a name="Customization-Examples-and-Solutions-to-Problems"></a>
voriges: <a rel="previous" accesskey="p" href="#Scenarios-for-use-_0028possibilities_002d_002dbased-on-actual-usage_0029">Scenarios for use (possibilities--based on actual usage)</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-the-S-family">ESS for the S family</a>
</div>
<h3 class="section">6.6 Customization Examples and Solutions to Problems</h3>
<p>1. Suppose that you are primarily an SPLUS 3.4 user, occasionally
using S version 4, and sick and tired of the buffer-name *S+3*
we've stuck you with. Simply edit the "ess-dialect" alist entry in
the essd-sp3.el and essd-s4.el files to be "S" instead of "S4" and
"S+3". This will ensure that all the inferior process buffer names
are "*S*".
<p>2. Suppose that you WANT to have the first buffer name indexed by
":1", in the same manner as your S-PLUS processes 2,3,4, and 5 (for
you heavy simulation people). Then uncomment the line in ess-site
(or add after your (require 'ess-site) or (load "ess-site") command
in your .emacs file, the line:
<pre class="example"> (setq ess-plain-first-buffername nil)
</pre>
<p>)
<p>3. Fontlocking sometimes fails to behave nicely upon errors. When
Splus dumps, a mis-matched " (double-quote) can result in the
wrong font-lock face being used for the remainder of the buffer.
<p>Solution: add a " at the end of the "Dumped..." statement, to
revert the font-lock face back to normal.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Editing"></a>
nächstes: <a rel="next" accesskey="n" href="#Editing-R-documentation-files">Editing R documentation files</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS-for-the-S-family">ESS for the S family</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">7 Editing S functions</h2>
<p><a name="index-editing-functions-122"></a>ESS provides facilities for editing S objects within your Emacs
session. Most editing is performed on S functions, although in
theory you may edit datasets as well. Edit buffers are always
associated with files, although you may choose to make these files
temporary if you wish. Alternatively, you may make use of a simple yet
powerful mechanism for maintaining backups of text representations of
S functions. Error-checking is performed when S code is loaded
into the ESS process.
<ul class="menu">
<li><a accesskey="1" href="#Edit-buffer">Edit buffer</a>: Edit objects in a specialized buffer
<li><a accesskey="2" href="#Loading">Loading</a>: Loading source files into the ESS process
<li><a accesskey="3" href="#Error-Checking">Error Checking</a>: Detecting errors in source files
<li><a accesskey="4" href="#Evaluating-code">Evaluating code</a>: Sending code to the ESS process
<li><a accesskey="5" href="#Indenting">Indenting</a>: Indenting and formatting S code
<li><a accesskey="6" href="#Other-edit-buffer-commands">Other edit buffer commands</a>: Commands for motion, completion and more
<li><a accesskey="7" href="#Source-Files">Source Files</a>: Maintaining S source files
<li><a accesskey="8" href="#Source-Directories">Source Directories</a>: Names and locations of dump files
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Edit-buffer"></a>
nächstes: <a rel="next" accesskey="n" href="#Loading">Loading</a>,
voriges: <a rel="previous" accesskey="p" href="#Editing">Editing</a>,
aufwärts: <a rel="up" accesskey="u" href="#Editing">Editing</a>
</div>
<h3 class="section">7.1 Creating or modifying S objects</h3>
<p><a name="index-edit-buffer-123"></a>
To edit an S object, type
<ul>
<li><kbd>C-c C-d</kbd> (<code>ess-dump-object-into-edit-buffer</code>) <br>
<a name="index-ess_002ddump_002dobject_002dinto_002dedit_002dbuffer-124"></a>Edit an S object in its own edit buffer.
</ul>
<p>from within the ESS process buffer (<code>*S*</code>). You will then be
prompted for an object to edit: you may either type in the name of an
existing object (for which completion is available using the <kbd>TAB</kbd>
key),
<a name="index-completion_002c-when-prompted-for-object-names-125"></a>or you may enter the name of a new object.
<a name="index-creating-new-objects-126"></a><a name="index-new-objects_002c-creating-127"></a>A buffer will be created containing the text representation of the
requested object or, if you entered the name of a non-existent object at
the prompt and the variable <code>ess-function-template</code>
<a name="index-ess_002dfunction_002dtemplate-128"></a>is non-<code>nil</code>, you will be presented with a template defined by that
variable, which defaults to a skeleton function construct.
<p>You may then edit the function as required. The edit buffer generated
by <code>ess-dump-object-into-edit-buffer</code> is placed in the <code>ESS</code>
major mode which provides a number of commands to facilitate editing
S source code. Commands are provided to intelligently indent S
code, evaluate portions of S code and to move around S code
constructs.
<p><a name="index-dump-files-129"></a><a name="index-reverting-function-definitions-130"></a>Note: when you dump a file with <kbd>C-c C-d</kbd>, ESS first checks
to see whether there already exists an edit buffer containing that
object and, if so, pops you directly to that buffer. If not, ESS next
checks whether there is a file in the appropriate place with the
appropriate name (see <a href="#Source-Files">Source Files</a>) and if so, reads in that file.
You can use this facility to return to an object you were editing in a
previous session (and which possibly was never loaded to the S
session). Finally, if both these tests fail, the ESS process is
consulted and a <code>dump()</code> command issued.
<a name="index-dump_0028_0029-131"></a>If you want to force ESS to ask the ESS process for the object's
definition (say, to reformat an unmodified buffer or to revert back to
S's idea of the object's definition) pass a prefix argument to
<code>ess-dump-object-into-edit-buffer</code> by typing <kbd>C-u C-c C-d</kbd>.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Loading"></a>
nächstes: <a rel="next" accesskey="n" href="#Error-Checking">Error Checking</a>,
voriges: <a rel="previous" accesskey="p" href="#Edit-buffer">Edit buffer</a>,
aufwärts: <a rel="up" accesskey="u" href="#Editing">Editing</a>
</div>
<h3 class="section">7.2 Loading source files into the ESS process</h3>
<p>The best way to get information — particularly function definitions
— into S is to load them in as source file, using S's
<code>source</code> function. You have already seen how to create source
files using <kbd>C-c C-d</kbd>; ESS provides a complementary command for
loading source files (even files not created with ESS!) into the ESS
process:
<ul>
<li><kbd>C-c C-l</kbd> (<code>ess-load-file</code>) <br>
<a name="index-ess_002dload_002dfile-132"></a>Loads a file into the ESS process using <code>source()</code>.
<a name="index-source_0028_0029-133"></a></ul>
<p class="noindent">After typing <kbd>C-c C-l</kbd> you will prompted for the name of the file to
load into S; usually this is the current buffer's file which is the
default value (selected by simply pressing <kbd>RET</kbd> at the prompt).
You will be asked to save the buffer first if it has been modified (this
happens automatically if the buffer was generated with <kbd>C-c C-d</kbd>).
The file will then be loaded, and if it loads successfully you will be
returned to the ESS process.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Error-Checking"></a>
nächstes: <a rel="next" accesskey="n" href="#Evaluating-code">Evaluating code</a>,
voriges: <a rel="previous" accesskey="p" href="#Loading">Loading</a>,
aufwärts: <a rel="up" accesskey="u" href="#Editing">Editing</a>
</div>
<h3 class="section">7.3 Detecting errors in source files</h3>
<p><a name="index-errors-134"></a><a name="index-parsing-errors-135"></a>If any errors occur when loading a file with <code>C-c C-l</code>, ESS will
inform you of this fact. In this case, you can jump directly to the
line in the source file which caused the error by typing <kbd>C-x `</kbd>
(<code>ess-parse-errors</code>).
<a name="index-ess_002dparse_002derrors-136"></a>You will be returned to the offending file (loading it into a buffer if
necessary) with point at the line S reported as containing the
error. You may then correct the error, and reload the file. Note that
none of the commands in an S source file will take effect if any
part of the file contains errors.
<p>Sometimes the error is not caused by a syntax error (loading a
non-existent file for example). In this case typing <kbd>C-x `</kbd> will
simply display a buffer containing S's error message. You can force
this behavior (and avoid jumping to the file when there <em>is</em> a
syntax error) by passing a prefix argument to <code>ess-parse-errors</code>
with <kbd>C-u C-x `</kbd>.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Evaluating-code"></a>
nächstes: <a rel="next" accesskey="n" href="#Indenting">Indenting</a>,
voriges: <a rel="previous" accesskey="p" href="#Error-Checking">Error Checking</a>,
aufwärts: <a rel="up" accesskey="u" href="#Editing">Editing</a>
</div>
<h3 class="section">7.4 Sending code to the ESS process</h3>
<p>Other commands are also available for evaluating portions of code in the
S process. These commands cause the selected code to be evaluated
directly by the ESS process as if you had typed them in at the
command line; the <code>source()</code> function is not used. You may choose
whether both the commands and their output appear in the process buffer
(as if you had typed in the commands yourself) or if the output alone is
echoed. The behavior is controlled by the variable
<code>ess-eval-visibly-p</code> whose default is <code>nil</code>
<a name="index-ess_002deval_002dvisibly_002dp-137"></a>(display output only). Passing a prefix argument (<kbd>C-u</kbd>) to any of
the following commands, however, reverses the meaning of
<code>ess-eval-visibly-p</code> for that command only — for example <kbd>C-u
C-c C-j</kbd> echoes the current line of S (or other) code in the ESS
process buffer, followed by its output. This method of evaluation is an
alternative to S's <code>source()</code> function
<a name="index-source_0028_0029-138"></a><a name="index-echoing-commands-when-evaluating-139"></a><a name="index-evaluating-code-with-echoed-commands-140"></a>when you want the input as well as the output to be displayed. (You can
sort of do this with <code>source()</code> when the option <code>echo=T</code> is
set, except that prompts do not get displayed. ESS puts prompts in the
right places.) The commands for evaluating code are:
<a name="index-evaluating-S-expressions-141"></a>
<ul><li><kbd>C-c C-j</kbd> (<code>ess-eval-line</code>) <br>
<a name="index-ess_002deval_002dline-142"></a>Send the line containing point to the ESS process.
<li><kbd>C-c M-j</kbd> (<code>ess-eval-line-and-go</code>) <br>
<a name="index-ess_002deval_002dline_002dand_002dgo-143"></a>As above, but returns you to the ESS process buffer as well.
<li><kbd>C-c C-f</kbd> or <kbd>ESC C-x</kbd> (aka <kbd>M-C-x</kbd>) (<code>ess-eval-function</code>) <br>
<a name="index-ess_002deval_002dfunction-144"></a>Send the S function containing point to the ESS process.
<li><kbd>C-c M-f</kbd> (<code>ess-eval-function-and-go</code>) <br>
<a name="index-ess_002deval_002dfunction_002dand_002dgo-145"></a>As above, but returns you to the ESS process buffer as well.
<li><kbd>C-c C-r</kbd> (<code>ess-eval-region</code>) <br>
<a name="index-ess_002deval_002dregion-146"></a>Send the text between point and mark to the ESS process.
<li><kbd>C-c M-r</kbd> (<code>ess-eval-region-and-go</code>) <br>
<a name="index-ess_002deval_002dregion_002dand_002dgo-147"></a>As above, but returns you to the ESS process buffer as well.
<li><kbd>C-c C-b</kbd> (<code>ess-eval-buffer</code>) <br>
<a name="index-ess_002deval_002dbuffer-148"></a>Send the contents of the edit buffer to the ESS process.
<li><kbd>C-c M-b</kbd> (<code>ess-eval-buffer-and-go</code>) <br>
<a name="index-ess_002deval_002dfunction_002dand_002dgo-149"></a>As above, but returns you to the ESS process buffer as well.
<li><kbd>C-c C-n</kbd> (<code>ess-eval-line-and-step</code>) <br>
<a name="index-ess_002deval_002dline_002dand_002dstep-150"></a><a name="index-stepping-through-code-151"></a><a name="index-debugging-S-functions-152"></a>Sends the current line to the ESS process, echoing it in the process
buffer, and moves point to the next line. Useful when debugging for
stepping through your code.
</ul>
<p>It should be stressed once again that these <code>ess-eval-</code> commands
should only be used for evaluating small portions of code for debugging
purposes, or for generating transcripts from source files. When editing
S functions, <kbd>C-c C-l</kbd> is the command to use to update the
function's value. In particular, <code>ess-eval-buffer</code> is now largely
obsolete.
<p>One final command is provided for spot-evaluations of S code:
<ul>
<kbd>C-c C-t</kbd> (<code>ess-execute-in-tb</code>) <br>
<a name="index-ess_002dexecute_002din_002dtb-153"></a>Prompt for an S expression and evaluate it. Displays result in a
temporary buffer.
</ul>
<p class="noindent">This is useful for quick calculations, etc.
<p>All the above commands are useful for evaluating small amounts of code
and observing the results in the process buffer. A useful way to work
is to divide the frame into two windows; one containing the source code
and the other containing the process buffer. If you wish to make the
process buffer scroll automatically when the output reaches the bottom
of the window, you will need to set the variable
<code>comint-scroll-to-bottom-on-output</code> to <code>'others</code> or <code>t</code>.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Indenting"></a>
nächstes: <a rel="next" accesskey="n" href="#Other-edit-buffer-commands">Other edit buffer commands</a>,
voriges: <a rel="previous" accesskey="p" href="#Evaluating-code">Evaluating code</a>,
aufwärts: <a rel="up" accesskey="u" href="#Editing">Editing</a>
</div>
<h3 class="section">7.5 Indenting and formatting S code</h3>
<p>ESS now provides a sophisticated mechanism for indenting S source
code (thanks to Ken'ichi Shibayama). Compound statements (delimited by
`<samp><span class="samp">{</span></samp>' and `<samp><span class="samp">}</span></samp>') are indented relative to their enclosing block.
In addition, the braces have been electrified to automatically indent to
the correct position when inserted, and optionally insert a newline at
the appropriate place as well. Lines which continue an incomplete
expression are indented relative to the first line of the expression.
Function definitions, <code>if</code> statements, calls to <code>expression()</code>
and loop constructs are all recognized and indented appropriately. User
variables are provided to control the amount if indentation in each
case, and there are also a number of predefined indentation styles to
choose from.
<p><a name="index-comments-in-S-154"></a>Comments are also handled specially by ESS, using an idea borrowed from
the Emacs-Lisp indentation style. By default,
comments beginning with `<samp><span class="samp">###</span></samp>'
are aligned to the beginning of the line. Comments beginning with
`<samp><span class="samp">##</span></samp>' are aligned to the current level of indentation for the block
containing the comment. Finally, comments beginning with `<samp><span class="samp">#</span></samp>' are
aligned to a column on the right (the 40th column by default, but this
value is controlled by the variable <code>comment-column</code>,)
<a name="index-comment_002dcolumn-155"></a>or just after the expression on the line containing the comment if it
extends beyond the indentation column. You turn off the default
behavior by adding the line
<code>(setq ess-fancy-comments nil)</code> to your <samp><span class="file">.emacs</span></samp> file.
<a name="index-ess_002dfancy_002dcomments-156"></a>
The indentation commands provided by ESS are:
<a name="index-indenting-157"></a><a name="index-formatting-source-code-158"></a>
<ul>
<li><kbd>TAB</kbd> (<code>ess-indent-command</code>) <br>
Indents the current line as S code. If a prefix argument is given,
all following lines which are part of the same (compound) expression are
indented by the same amount (but relative indents are preserved).
<li><kbd>LFD</kbd> (<code>newline-and-indent</code>) <br>
Insert a newline, and indent the next line. (Note: if your keyboard
does not have a <LINEFEED> key, you can use <kbd>C-j</kbd> instead.)
Some people prefer to bind <RET> to this command.
<li><kbd>ESC C-q</kbd> aka <kbd>M-C-q</kbd> aka <kbd>C-M-q</kbd> (<code>ess-indent-exp</code>) <br>
Indents each line in the S (compound) expression which follows point.
Very useful for beautifying your S code.
<li><kbd>{</kbd> and <kbd>}</kbd> (<code>ess-electric-brace</code>) <br>
The braces automatically indent to the correct position when typed.
<li><kbd>M-;</kbd> (<code>indent-for-comment</code>) <br>
Indents a comment line appropriately, or inserts an empty
(single-`<samp><span class="samp">#</span></samp>') comment.
<li><kbd>M-x ess-set-style</kbd> <br>
Set the formatting style in this buffer to be one of the predefined
styles: <code>GNU</code>, <code>BSD</code>, <code>K&R</code>, <code>CLB</code>, and <code>C++</code>.
The <code>DEFAULT</code> style uses the default values for the indenting
variables (unless they have been modified in your <samp><span class="file">.emacs</span></samp> file.)
<a name="index-g_t_0040file_007b_002eemacs_007d-file-159"></a>This command causes all of the formatting variables to be buffer-local.
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Other-edit-buffer-commands"></a>
nächstes: <a rel="next" accesskey="n" href="#Source-Files">Source Files</a>,
voriges: <a rel="previous" accesskey="p" href="#Indenting">Indenting</a>,
aufwärts: <a rel="up" accesskey="u" href="#Editing">Editing</a>
</div>
<h3 class="section">7.6 Commands for motion, completion and more</h3>
<p>A number of commands are provided to move across function definitions
in the edit buffer:
<ul>
<li><kbd>ESC C-a</kbd> aka <kbd>C-M-a</kbd> (<code>ess-beginning-of-function</code>) <br>
<a name="index-ess_002dbeginning_002dof_002dfunction-160"></a>Moves point to the beginning of the function containing point.
<li><kbd>ESC C-e</kbd> aka <kbd>C-M-e</kbd> (<code>ess-end-of-function</code>) <br>
<a name="index-ess_002dend_002dof_002dfunction-161"></a>Moves point to the end of the function containing point.
<li><kbd>ESC C-h</kbd> aka <kbd>C-M-h</kbd> (<code>ess-mark-function</code>) <br>
Places point at the beginning of the S function containing point, and
mark at the end.
</ul>
Don't forget the usual Emacs commands for moving over balanced
expressions and parentheses: Siehe <a href="Emacs.html#Lists">Lists and Sexps</a>.
<p><a name="index-completion-in-edit-buffer-162"></a>Completion is provided in the edit buffer in a similar fashion to the
process buffer: <kbd>M-TAB</kbd> completes file names and <kbd>M-?</kbd> lists
file completions. Since <TAB> is used for indentation in the edit
buffer, object completion is now performed with <kbd>C-c TAB</kbd>. Note
however that completion is only provided over globally known S objects
(such as system functions) — it will <em>not</em> work for arguments to
functions or other variables local to the function you are editing.
<p>Finally, two commands are provided for returning to the ESS process buffer:
<ul>
<li><kbd>C-c C-z</kbd> (<code>ess-switch-to-end-of-ESS</code>) <br>
<a name="index-ess_002dswitch_002dto_002dend_002dof_002dESS-163"></a>Returns you to the ESS process buffer, placing point at the end of the
buffer.
<li><kbd>C-c C-y</kbd> (<code>ess-switch-to-ESS</code>) <br>
<a name="index-ess_002dswitch_002dto_002dESS-164"></a>Also returns to to the ESS process buffer, but leaves point where it was.
</ul>
<p>In addition some commands available in the process buffer are also
available in the edit buffer. You can still read help files with
<kbd>C-c C-v</kbd>, edit another function with <kbd>C-c C-d</kbd> and of course
<kbd>C-c C-l</kbd> can be used to load a source file into S. Siehe <a href="#Other">Other</a>,
for more details on these commands.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Source-Files"></a>
nächstes: <a rel="next" accesskey="n" href="#Source-Directories">Source Directories</a>,
voriges: <a rel="previous" accesskey="p" href="#Other-edit-buffer-commands">Other edit buffer commands</a>,
aufwärts: <a rel="up" accesskey="u" href="#Editing">Editing</a>
</div>
<h3 class="section">7.7 Maintaining S source files</h3>
<p>Every edit buffer in ESS is associated with a <dfn>dump file</dfn> on disk.
Dump files are created whenever you type <kbd>C-c C-d</kbd>
(<code>ess-dump-object-into-edit-buffer</code>), and may either be deleted
after use, or kept as a backup file or as a means of keeping several
versions of an S function.
<a name="index-dump-files-165"></a>
<div class="defun">
— User Option: <b>ess-delete-dump-files</b><var><a name="index-ess_002ddelete_002ddump_002dfiles-166"></a></var><br>
<blockquote><p>If non-<code>nil</code>, dump files created with C-c C-d are deleted
immediately after they are created by the ess-process.
</p></blockquote></div>
<p>Since immediately after S dumps an object's definition to a disk
file the source code on disk corresponds exactly to S's idea of the
object's definition, the disk file isn't needed; deleting it now has the
advantage that if you <em>don't</em> modify the file (say, because you
just wanted to look at the definition of one of the standard S
functions) the source dump file won't be left around when you kill the
buffer. Note that this variable only applies to files generated with
S's <code>dump</code> function; it doesn't apply to source files which already
exist. The default value is <code>t</code>.
<div class="defun">
— User Option: <b>ess-keep-dump-files</b><var><a name="index-ess_002dkeep_002ddump_002dfiles-167"></a></var><br>
<blockquote><p>Option controlling what to do with the dump file after an object has
been successfully loaded into S. Valid values are <code>nil</code> (always
delete), <code>ask</code> (always ask whether to delete), <code>check</code> (delete
files generated with <kbd>C-c C-d</kbd> in this Emacs session, otherwise ask
— this is the default) and <code>t</code> (never delete). This variable is
buffer-local.
</p></blockquote></div>
<p>After an object has been successfully (i.e. without error) loaded
back into S with <kbd>C-c C-l</kbd>, the disk file again corresponds
exactly (well, almost — see below) to S's record of the object's
definition, and so some people prefer to delete the disk file rather
than unnecessarily use up space. This option allows you to do just
that.
<p><a name="index-comments-168"></a><a name="index-project-work-in-S-169"></a><a name="index-historic-backups-170"></a>If the value of <code>ess-keep-dump-files</code> is <code>t</code>, dump files are
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 <a href="emacs.html#Backup-Names">Single or Numbered Backups</a>, you can keep a historic
record of function definitions. Another possibility is to maintain the
files with a version-control system such as RCS Siehe <a href="emacs.html#Version-Control">Version Control</a>. As long as a dump file exists in the appropriate place for a
particular object, editing that object with <kbd>C-c C-d</kbd> finds that
file for editing (unless a prefix argument is given) — the ESS
process is not consulted. Thus you can keep comments <em>outside</em> the
function definition as a means of documentation that does not clutter
the S object itself. Another useful feature is that you may format
the code in any fashion you please without S re-indenting the code
every time you edit it. These features are particularly useful for
project-based work.
<p>If the value of <code>ess-keep-dump-files</code> is nil, the dump file is always
silently deleted after a successful load with <kbd>C-c C-l</kbd>. While this
is useful for files that were created with <kbd>C-c C-d</kbd> it also applies
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 <code>ess-keep-dump-files</code> is buffer-local, you can make
sure particular files are not deleted by setting it to <code>t</code> in the
Local Variables section of the file Siehe <a href="emacs.html#File-Variables">Local Variables in Files</a>.
<p>A safer option is to set <code>ess-keep-dump-files</code> to <code>ask</code>; this
means that ESS will always ask for confirmation before deleting the
file. Since this can get annoying if you always want to delete dump
files created with <code>C-c C-d</code>, but not any other files, setting
<code>ess-keep-dump-files</code> to <code>check</code> (the default value) will
silently delete dump files created with <kbd>C-c C-d</kbd> in the current
Emacs session, but query for any other file. Note that in any case you
will only be asked for confirmation once per file, and your answer is
remembered for the rest of the Emacs session.
<p>Note that in all cases, if an error (such as a syntax error) is detected
while loading the file with <kbd>C-c C-l</kbd>, the dump file is <em>never</em>
deleted. This is so that you can edit the file in a new Emacs session
if you happen to quit Emacs before correcting the error.
<p><a name="index-autosaving-171"></a>Dump buffers are always autosaved, regardless of the value of
<code>ess-keep-dump-files</code>.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Source-Directories"></a>
voriges: <a rel="previous" accesskey="p" href="#Source-Files">Source Files</a>,
aufwärts: <a rel="up" accesskey="u" href="#Editing">Editing</a>
</div>
<h3 class="section">7.8 Names and locations of dump files</h3>
<p><a name="index-dump-file-names-172"></a>Every dump file should be given a unique file name, usually the dumped
object name with some additions.
<div class="defun">
— User Option: <b>ess-dump-filename-template</b><var><a name="index-ess_002ddump_002dfilename_002dtemplate-173"></a></var><br>
<blockquote><p>Template for filenames of dumped objects. <code>%s</code> is replaced by the
object name.
</p></blockquote></div>
<p class="noindent">By default, dump file names are the user name, followed by `<samp><span class="samp">.</span></samp>' and
the object and ending with `<samp><span class="samp">.S</span></samp>'. Thus if user <code>joe</code> dumps the
object <code>myfun</code> the dump file will have name <samp><span class="file">joe.myfun.S</span></samp>.
The username part is included to avoid clashes when dumping into a
publicly-writable directory, such as <samp><span class="file">/tmp</span></samp>; you may wish to remove
this part if you are dumping into a directory owned by you.
<p><a name="index-dump-file-directories-174"></a>You may also specify the directory in which dump files are written:
<div class="defun">
— User Option: <b>ess-source-directory</b><var><a name="index-ess_002dsource_002ddirectory-175"></a></var><br>
<blockquote><p>Directory name (ending in a slash) where S dump files are to be written.
</p></blockquote></div>
<p>By default, dump files are always written to <samp><span class="file">/tmp</span></samp>, which is fine
when <code>ess-keep-dump-files</code> is <code>nil</code>. If you are keeping dump
files, then you will probably want to keep them somewhere in your home
directory, say <samp><span class="file">~/S-source</span></samp>. This could be achieved by including
the following line in your <samp><span class="file">.emacs</span></samp> file:
<a name="index-g_t_0040file_007b_002eemacs_007d-file-176"></a>
<pre class="example"> (setq ess-source-directory (expand-file-name "~/S-source/"))
</pre>
<p>If you would prefer to keep your dump files in separate directories
depending on the value of some variable, ESS provides a facility for
this also. By setting <code>ess-source-directory</code> to a lambda
expression which evaluates to a directory name, you have a great deal of
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 <samp><span class="file">Src</span></samp> of the
directory the ESS process was run in.
<pre class="example"> (setq ess-source-directory
(lambda ()
(concat ess-directory "Src/")))
</pre>
<p class="noindent"><a name="index-ess_002ddirectory-177"></a>(<code>ess-directory</code> is a buffer-local variable in process buffers
which records the directory the ESS process was run from.) This is
useful if you keep your dump files and you often edit objects with the
same name in different ESS processes. Alternatively, if you often
change your S working directory during an S session, you may
like to keep dump files in some subdirectory of the directory pointed to
by the first element of the current search list. This way you can edit
objects of the same name in different directories during the one S
session:
<a name="index-search-list-178"></a><a name="index-working-directory-179"></a>
<pre class="example"> (setq ess-source-directory
(lambda ()
(file-name-as-directory
(expand-file-name (concat
(car ess-search-list)
"/.Src")))))
</pre>
<p><a name="index-ess_002dsearch_002dlist-180"></a>
If the directory generated by the lambda function does not exist but can
be created, you will be asked whether you wish to create the directory.
If you choose not to, or the directory cannot be created, you will not
be able to edit functions.
<div class="node">
<p><hr>
<a name="Editing-R-documentation-files"></a>
nächstes: <a rel="next" accesskey="n" href="#Help">Help</a>,
voriges: <a rel="previous" accesskey="p" href="#Editing">Editing</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">8 Editing R documentation files</h2>
<p>ESS also provides support for editing <dfn>R documentation</dfn> (“Rd”)
files. R objects are documented in files written in Rd format, a
simple markup language closely resembling (La)TeX, which can be
processed into a variety of formats, including LaTeX, <acronym>HTML</acronym>,
and plain text. Rd format is described in section “Rd format” of the
“Writing R Extensions” manual in the R distribution.
<p>Visiting an Rd file as characterized by its extension <samp><span class="file">Rd</span></samp> 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).
<p>Note that R also accepts Rd files with extension <samp><span class="file">rd</span></samp>; to activate
ESS[Rd] support for this extension, you may need to add
<pre class="example"> (add-to-list 'auto-mode-alist '("\\.rd\\'" . Rd-mode))
</pre>
<p class="noindent">to one of your Emacs startup files.
<p>In Rd mode, the following special Emacs commands can be used in addition
to the standard Emacs commands.
<dl>
<dt><kbd>C-h m</kbd><dd>Describe the features of Rd mode.
<br><dt><kbd>LFD</kbd><dt><kbd>RET</kbd><dd>Reindent the current line, insert a newline and indent the new line
(<code>reindent-then-newline-and-indent</code>). An abbrev before point is
expanded if <code>abbrev-mode</code> is non-<code>nil</code>.
<br><dt><kbd>TAB</kbd><dd>Indent current line based on its contents and on previous lines
(<code>indent-according-to-mode</code>).
<br><dt><kbd>C-c C-e</kbd><dd>Insert a “skeleton” with Rd markup for at least all mandatory entries
in Rd files (<code>Rd-mode-insert-skeleton</code>). Note that many users
might prefer to use the R function <code>prompt</code> on an existing R object
to generate a non-empty Rd “shell” documenting the object (which
already has all information filled in which can be obtained from the
object).
<br><dt><kbd>C-c C-f</kbd><dd>Insert “font” specifiers for some of the Rd markup commands markup
available for emphasizing or quoting text, including markup for URLs and
email addresses (<code>Rd-font</code>). <kbd>C-c C-f</kbd> is only a prefix; see
e.g. <kbd>C-c C-f TAB</kbd> for the available bindings. Note that
currently, not all of the Rd text markup as described in section
“Marking text” of “Writing R Extensions” can be accessed via
<kbd>C-c C-f</kbd>.
<br><dt><kbd>C-c C-j</kbd><dd>Insert a suitably indented `<samp><span class="samp">\item{</span></samp>' on the next line
(<code>Rd-mode-insert-item</code>).
<br><dt><kbd>C-c C-p</kbd><dd>Preview a plain text version (“help file”, see <a href="#Help">Help</a>) generated
from the Rd file (<code>Rd-preview-help</code>).
</dl>
<p>In addition, when editing Rd files one can interact with a running R
process in a similar way as when editing R language files. E.g.,
<kbd>C-c C-v</kbd> provides access to on-line help, and <kbd>C-c C-n</kbd> sends
the current line to the R process for evaluation. This interaction is
particularly useful when editing the examples in the Rd file. See
<kbd>C-h m</kbd> for all available commands.
<p>Rd mode also provides access to abbreviations for most of the Rd markup
commands. Type <kbd>M-x list-abbrevs</kbd> with Abbrev mode turned on to
list all available abbrevs. Note that all Rd abbrevs start with a grave
accent.
<p>Rd mode can be customized via the following variables.
<dl>
<dt><code>Rd-mode-hook</code><dd>Hook to be run when Rd mode is entered.
<br><dt><code>Rd-indent-level</code><dd>The indentation of Rd code with respect to containing blocks. Default
is 2.
<br><dt><code>Rd-to-help-command</code><dd>The shell command used for converting Rd source to help text. Default
is `<samp><span class="samp">R CMD Rd2txt</span></samp>'.
</dl>
<p>To automatically turn on the abbrev and font-lock features of Rd mode,
add the following lines to one of your Emacs startup files:
<pre class="example"> (add-hook 'Rd-mode-hook
(lambda ()
(abbrev-mode 1)
(font-lock-mode 1)))
</pre>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Help"></a>
nächstes: <a rel="next" accesskey="n" href="#ESS-for-SAS">ESS for SAS</a>,
voriges: <a rel="previous" accesskey="p" href="#Editing-R-documentation-files">Editing R documentation files</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">9 Reading help files</h2>
<p><a name="index-help-files-181"></a>
ESS provides an easy-to-use facility for reading S help files from
within Emacs. From within the ESS process buffer or any ESS edit
buffer, typing <kbd>C-c C-v</kbd> (<code>ess-display-help-on-object</code>)
<a name="index-ess_002ddisplay_002dhelp_002don_002dobject-182"></a>will prompt you for the name of an object for which you would like
documentation. Completion is provided over all objects which have help
files.
<p>If the requested object has documentation, you will be popped into a
buffer (named <code>*help(</code><var>obj-name</var><code>)*</code>) containing the help file.
This buffer is placed in a special `S Help' mode which disables the
usual editing commands but which provides a number of keys for paging
through the help file:
<ul>
Help commands:
<li><kbd>?</kbd> (<code>ess-describe-help-mode</code>) <br>
<a name="index-ess_002ddescribe_002dhelp_002dmode-183"></a>Pops up a help buffer with a list of the commands available in S help
mode.
<li><kbd>h</kbd> (<code>ess-display-help-on-object</code>) <br>
<a name="index-ess_002ddisplay_002dhelp_002don_002dobject-184"></a>Pop up a help buffer for a different object
<p>Paging commands:
<p><a name="index-paging-commands-in-help-buffers-185"></a><li><kbd>b</kbd> or <kbd>DEL</kbd> (<code>scroll-down</code>) <br>
Move one page backwards through the help file.
<li><kbd>SPC</kbd> (<code>scroll-up</code>) <br>
Move one page forwards through the help file.
<li><kbd>></kbd> (<code>beginning-of-buffer</code>) and <kbd><</kbd> (<code>end-of-buffer</code>)
<br>
Move to the beginning and end of the help file, respectively.
<p>Section-based motion commands:
<li><kbd>n</kbd> (<code>ess-skip-to-next-section</code>) and <kbd>p</kbd>
(<code>ess-skip-to-previous-section</code>) <br> Move to the next and previous
<a name="index-ess_002dskip_002dto_002dnext_002dsection-186"></a><a name="index-ess_002dskip_002dto_002dprevious_002dsection-187"></a>section header in the help file, respectively. A section header
consists of a number of capitalized words, followed by a colon.
<p>In addition, the <kbd>s</kbd> key followed by one of the following letters
will jump to a particular section in the help file:
<a name="index-ess_002dskip_002dto_002dhelp_002dsection-188"></a>
<dl>
<dt>`<samp><span class="samp">a</span></samp>'<dd>ARGUMENTS:
<br><dt>`<samp><span class="samp">b</span></samp>'<dd>BACKGROUND:
<br><dt>`<samp><span class="samp">B</span></samp>'<dd>BUGS:
<br><dt>`<samp><span class="samp">d</span></samp>'<dd>DETAILS:
<br><dt>`<samp><span class="samp">D</span></samp>'<dd>DESCRIPTION:
<br><dt>`<samp><span class="samp">e</span></samp>'<dd>EXAMPLES:
<br><dt>`<samp><span class="samp">n</span></samp>'<dd>NOTE:
<br><dt>`<samp><span class="samp">o</span></samp>'<dd>OPTIONAL ARGUMENTS:
<br><dt>`<samp><span class="samp">r</span></samp>'<dd>REQUIRED ARGUMENTS:
<br><dt>`<samp><span class="samp">R</span></samp>'<dd>REFERENCES:
<br><dt>`<samp><span class="samp">s</span></samp>'<dd>SIDE EFFECTS:
<br><dt>`<samp><span class="samp">s</span></samp>'<dd>SEE ALSO:
<br><dt>`<samp><span class="samp">u</span></samp>'<dd>USAGE:
<br><dt>`<samp><span class="samp">v</span></samp>'<dd>VALUE:
<br><dt>`<samp><span class="samp"><</span></samp>'<dd>Jumps to beginning of file
<br><dt>`<samp><span class="samp">></span></samp>'<dd>Jumps to end of file
<br><dt>`<samp><span class="samp">?</span></samp>'<dd>Pops up a help buffer with a list of the defined section motion keys.
</dl>
<p>Miscellaneous:
<li><kbd>l</kbd> (<code>ess-eval-line-and-step</code>) <br>
<a name="index-ess_002deval_002dline_002dand_002dstep-189"></a>Evaluates the current line in the ESS process, and moves to the next
line. Useful for running examples in help files.
<li><kbd>r</kbd> (<code>ess-eval-region</code>) <br>
<a name="index-ess_002deval_002dregion-190"></a>Send the contents of the current region to the ESS process. Useful
for running examples in help files.
<li><kbd>/</kbd> (<code>isearch-forward</code>) <br>
Same as <kbd>C-s</kbd>.
<p>Quit commands:
<li><kbd>q</kbd> (<code>ess-switch-to-end-of-ESS</code>) <br>
<a name="index-ess_002dswitch_002dto_002dend_002dof_002dESS-191"></a>Returns to the ESS process buffer in another window, leaving the
help window visible.
<li><kbd>k</kbd> (<code>kill-buffer</code>) <br>
Kills the help buffer.
<li><kbd>x</kbd> (<code>ess-kill-buffer-and-go</code>) <br>
Return to the ESS process, killing this help buffer.
</ul>
<p>In addition, all of the ESS commands available in the edit buffers are
also available in S help mode (see <a href="#Edit-buffer">Edit buffer</a>). Of course, the
usual (non-editing) Emacs commands are available, and for convenience
the digits and <-> act as prefix arguments.
<p>If a help buffer already exists for an object for which help is
requested, that buffer is popped to immediately; the ESS process is
not consulted at all. If the contents of the help file have changed,
you either need to kill the help buffer first, or pass a prefix argument
(with <kbd>C-u</kbd>) to <code>ess-display-help-on-object</code>.
<p>Help buffers are marked as temporary buffers in ESS, and are deleted
when <code>ess-quit</code> or <code>ess-cleanup</code> are called.
<p>Help buffers normally appear in another window within the current
frame. If you wish help buffers to appear in their own frame (either
one per help buffer, or one for all help buffers), you can customize the
variable <code>ess-help-own-frame</code>.
<p><a name="index-ess_002dquit-192"></a><a name="index-ess_002dcleanup-193"></a><a name="index-temporary-buffers-194"></a>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS-for-SAS"></a>
nächstes: <a rel="next" accesskey="n" href="#ESS-for-BUGS">ESS for BUGS</a>,
voriges: <a rel="previous" accesskey="p" href="#Help">Help</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">10 ESS for SAS</h2>
<ul class="menu">
<li><a accesskey="1" href="#ESS_0028SAS_0029_002d_002dDesign-philosophy">ESS(SAS)--Design philosophy</a>
<li><a accesskey="2" href="#ESS_0028SAS_0029_002d_002dEditing-files">ESS(SAS)--Editing files</a>
<li><a accesskey="3" href="#ESS_0028SAS_0029_002d_002dTAB-key">ESS(SAS)--TAB key</a>
<li><a accesskey="4" href="#ESS_0028SAS_0029_002d_002dBatch-SAS-processes">ESS(SAS)--Batch SAS processes</a>
<li><a accesskey="5" href="#ESS_0028SAS_0029_002d_002dFunction-keys-for-batch-processing">ESS(SAS)--Function keys for batch processing</a>
<li><a accesskey="6" href="#iESS_0028SAS_0029_002d_002dInteractive-SAS-processes">iESS(SAS)--Interactive SAS processes</a>
<li><a accesskey="7" href="#iESS_0028SAS_0029_002d_002dCommon-problems">iESS(SAS)--Common problems</a>
<li><a accesskey="8" href="#ESS_0028SAS_0029_002d_002dGraphics">ESS(SAS)--Graphics</a>
<li><a accesskey="9" href="#ESS_0028SAS_0029_002d_002dMS-Windows">ESS(SAS)--MS Windows</a>
</ul>
<p>ESS[SAS] was designed for use with SAS. It is descended from emacs
macros developed by John Sall for editing SAS programs and SAS-mode by
Tom Cook. Those editing features and new advanced features are part of
ESS[SAS]. The user interface of ESS[SAS] has similarities with ESS[S]
and the SAS Display Manager.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS(SAS)--Design-philosophy"></a>
<a name="ESS_0028SAS_0029_002d_002dDesign-philosophy"></a>
nächstes: <a rel="next" accesskey="n" href="#ESS_0028SAS_0029_002d_002dEditing-files">ESS(SAS)--Editing files</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS-for-SAS">ESS for SAS</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-SAS">ESS for SAS</a>
</div>
<h3 class="section">10.1 ESS[SAS]–Design philosophy</h3>
<p>ESS[SAS] was designed to aid the user in writing and maintaining
SAS programs, such as myfile.sas. Both interactive and batch submission
of SAS programs is supported.
<p>ESS[SAS] was written with two primary goals.
<p>1. The emacs text editor provides a powerful and flexible development
environment for programming languages. These features are a boon to all
programmers and, with the help of ESS[SAS], to SAS users as well.
<p>2. Although a departure from SAS Display Manager, ESS[SAS] provides
similar key definitions to give novice ESS[SAS] users a head start.
Also, inconvenient SAS Display Manager features, like remote submission
and syntax highlighting, are provided transparently; appealing to
advanced ESS[SAS] users.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS(SAS)--Editing-files"></a>
<a name="ESS_0028SAS_0029_002d_002dEditing-files"></a>
nächstes: <a rel="next" accesskey="n" href="#ESS_0028SAS_0029_002d_002dTAB-key">ESS(SAS)--TAB key</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS_0028SAS_0029_002d_002dDesign-philosophy">ESS(SAS)--Design philosophy</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-SAS">ESS for SAS</a>
</div>
<h3 class="section">10.2 ESS[SAS]–Editing files</h3>
<p>ESS[SAS] is the mode for editing SAS language files. This mode handles:
<pre class="display"> - proper indenting, generated by both [Tab] and [Return].
- color and font choices based on syntax.
- ability to send the contents of an entire buffer, a highlighted region,
or a single line to an interactive SAS process.
- ability to switch between processes which would be the target of the
buffer (for the above).
- ability to save and submit the file you are working on as a batch SAS
process with a single keypress and to continue editing while it is runs
in the background.
- capability of killing the batch SAS process through the shell buffer or
allow the SAS process to keep on running after you exit emacs.
- single keypress navigation of .sas, .log and .lst files (.log and .lst
files are automatically refreshed with each keypress).
</pre>
<p>ESS[SAS] is automatically turned on when editing a file with a .sas
suffix (or other extension, if specified via 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
to start an inferior SAS process with M-x SAS
(Siehe <a href="#iESS_0028SAS_0029_002d_002dInteractive-SAS-processes">iESS(SAS)–Interactive SAS processes</a>.)
<p>At this writing, the indenting and syntax highlighting are generally
correct. Known issues: for multiple line * or %* comments, only the
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 a DO ... TO
or a DO ... TO ... BY statement, TOs are not highlighted (and neither is
BY).
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS(SAS)--TAB-key"></a>
<a name="ESS_0028SAS_0029_002d_002dTAB-key"></a>
nächstes: <a rel="next" accesskey="n" href="#ESS_0028SAS_0029_002d_002dBatch-SAS-processes">ESS(SAS)--Batch SAS processes</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS_0028SAS_0029_002d_002dEditing-files">ESS(SAS)--Editing files</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-SAS">ESS for SAS</a>
</div>
<h3 class="section">10.3 ESS[SAS]–TAB key</h3>
<p>Two options. The TAB key is bound by default to sas-indent-line. This
function is used to syntactically indent SAS code so PROC and RUN are in
the left margin, other statements are indented 4 spaces from the margin,
continuation lines are indented 4 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:
<pre class="example"> (setq ess-sas-edit-keys-toggle nil)
</pre>
<p>ESS provides an alternate behavior for the TAB key that makes it behave
as it does in SAS Display Manager, i.e. move the cursor to the next tab
stop. The alternate behavior also provides a backwards TAB, C-TAB, that
moves the cursor to the tab stop to the left and deletes any characters
between them. This functionality is obtained by uncommenting the
following line in ess-site.el:
<pre class="example"> (setq ess-sas-edit-keys-toggle t)
</pre>
<p>Under the alternate behavior, the TAB key is bound to tab-to-tab-stop
and the tab stops are set at multiples of sas-indent-width.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS(SAS)--Batch-SAS-processes"></a>
<a name="ESS_0028SAS_0029_002d_002dBatch-SAS-processes"></a>
nächstes: <a rel="next" accesskey="n" href="#ESS_0028SAS_0029_002d_002dFunction-keys-for-batch-processing">ESS(SAS)--Function keys for batch processing</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS_0028SAS_0029_002d_002dTAB-key">ESS(SAS)--TAB key</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-SAS">ESS for SAS</a>
</div>
<h3 class="section">10.4 ESS[SAS]–Batch SAS processes</h3>
<p>Submission of a SAS batch job is dependent on your environment.
ess-sas-submit-method is determined by your operating system and your
shell. It defaults to 'sh unless you are running Windows or Mac
Classic. Under Windows, it will default to 'sh if you are using a
Unix-imitating shell; otherwise 'ms-dos for an MS-DOS shell. On Mac OS
X, it will default to 'sh, but under Mac Classic AppleScript is used
('apple-script). You will also set this to 'sh if the SAS batch job
needs to run on a remote machine rather than your local machine. This
works transparently if you are editing the remote file via ange-ftp/EFS
or tramp. Note that ess-sas-shell-buffer-remote-init is a Local
Variable that defaults to "ssh" which will be used to open the buffer on
the remote host and it is assumed that no password is necessary,
i.e. you are using the equivalent of ssh-agent/ssh-add (see the
discussion about Local Variables below if you need to change the
default).
<p>However, if you are editing the file locally and transferring it back
and forth with Kermit, you need some additional steps. First, start
Kermit 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 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 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 ess-kermit-command.
<p>The command used by the SUBMIT function key (F3 or F8) to submit a batch
SAS job, whether local or remote, is ess-sas-submit-command which
defaults to sas-program. sas-program is "invoke SAS using program file"
for Mac Classic and "sas" otherwise. However, you may have to alter
ess-sas-submit-command for a particular program, so it is defined as
buffer-local. Conveniently, it can be set at the end of the program:
<pre class="example"> endsas;
Local variables:
ess-sas-submit-command: "sas8"
End:
</pre>
<p>The command line is also made of 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 file (you may also use
M-x customize-variable):
<pre class="example"> ;'sh default
(setq ess-sas-submit-pre-command "nohup")
;'sh default
(setq ess-sas-submit-post-command "-rsasuser &")
;'sh example
(setq-default ess-sas-submit-command "/usr/local/sas/sas")
;'ms-dos default
(setq ess-sas-submit-pre-command "start")
;'ms-dos default
(setq ess-sas-submit-post-command "-rsasuser -icon")
;Windows example
(setq-default ess-sas-submit-command "c:/progra~1/sas/sas.exe")
;Windows example
(setq-default ess-sas-submit-command "c:\\progra~1\\sas\\sas.exe")
</pre>
<p>There is a built-in delay before a batch SAS job is submitted when using
a Unix-imitating shell under Windows. This is necessary in many cases
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
file by:
<pre class="example"> (setq ess-sleep-for 0.2)
</pre>
<p>For example, open the file you want to work with
(ess-sas-global-unix-keys keys shown, ess-sas-global-pc-keys in
parentheses; ESS[SAS] function keys are presented in the next section).
<pre class="example"> C-x C-f myfile.sas
</pre>
<p>myfile.sas will be in ESS[SAS] mode. Edit as appropriate, then save and
submit the batch SAS job.
<pre class="example"> F3 (F8)
</pre>
<p>The job runs in the shell buffer while you continue to edit
myfile.sas. If 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.
<pre class="example"> F8 (F3)
</pre>
<p>Terminating a SAS batch in the *shell* buffer.
<pre class="example"> kill %1
</pre>
<p>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 1st error message, if any.
<pre class="example"> F5 (F6)
</pre>
<p>Goto the next error message, if any.
<pre class="example"> F5 (F6)
</pre>
<p>Now, refresh the .lst and go to it's buffer.
<pre class="example"> F6 (F7)
</pre>
<p>If you wish to make changes, go to the .sas file with.
<pre class="example"> F4 (F5)
</pre>
<p>Make your editing changes and submit again.
<pre class="example"> F3 (F8)
</pre>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS(SAS)--Function-keys-for-batch-processing"></a>
<a name="ESS_0028SAS_0029_002d_002dFunction-keys-for-batch-processing"></a>
nächstes: <a rel="next" accesskey="n" href="#iESS_0028SAS_0029_002d_002dInteractive-SAS-processes">iESS(SAS)--Interactive SAS processes</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS_0028SAS_0029_002d_002dBatch-SAS-processes">ESS(SAS)--Batch SAS processes</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-SAS">ESS for SAS</a>
</div>
<h3 class="section">10.5 ESS[SAS]–Function keys for batch processing</h3>
<p>The setup of function keys for SAS batch processing
is unavoidably complex, but the usage of function keys is simple.
There are five distinct options:
<p>Option 1 (default). Function keys in ESS[SAS] are not bound to elisp
commands. This is in accordance with the GNU Elisp Coding Standards
(GECS) which do not allow function keys to be bound so that they are
available to the user.
<p>Options 2-5. Since GECS does not allow function keys to be bound by
modes, these keys are often unused. So, ESS[SAS] provides users with
the option of binding elisp commands to these keys. Users who are
familiar with SAS will, most likely, want to duplicate the function key
capabilities of the SAS Display Manager. There are four options (noted
in parentheses).
<ol type=a start=1>
<li>SAS Display Manager has different function key definitions for
Unix (2, 4) and Windows (3, 5); ESS can use either.
<li>The ESS[SAS] function key definitions can be active in all buffers
(global: 4, 5) or limited (local: 2, 3) only to buffers with files that
are associated with ESS[SAS] as specified in your auto-mode-alist.
</ol>
<p>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
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
SAS files, and to behave normally when editing other files, then you
will choose the local definitions. The option can be chosen by the
person installing ESS for a site or by an individual.
<ol type=a start=1>
<li>For a site installation or an individual, uncomment ONLY ONE of the
following lines in your ess-site.el. ESS[SAS] Function keys are
available in ESS[SAS] if you uncomment either 2 or 3 and in all modes if
you uncomment 4 or 5:
<pre class="example"> ;;2; (setq ess-sas-local-unix-keys t)
;;3; (setq ess-sas-local-pc-keys t)
;;4; (setq ess-sas-global-unix-keys t)
;;5; (setq ess-sas-global-pc-keys t)
</pre>
<p>The names -unix- and -pc- have nothing to do with the operating system
that you are running. Rather, they mimic the definitions that the SAS
Display Manager uses by default on those platforms.
<li>If your site installation has configured the keys contrary to your
liking, then you must call the appropriate function.
<pre class="example"> (load "ess-site") ;; local-unix-keys
(ess-sas-global-pc-keys)
</pre>
</ol>
<p>Finally, we get to what the function keys actually do. You may recognize
some of the nicknames as SAS Display Manager commands (they are in all
capitals).
<pre class="display"> Unix PC Nickname "inferior" Alias (if any) and Description
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 C-c C-b
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
F5 F6 LOG C-c C-x
switch buffer to .log file, `refresh' and goto next
error message, if any
F6 F7 OUTPUT C-c C-y
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 shell
F9 F9 VIEWTABLE
open an interactive FSEDIT/FSBROWSE session on the SAS
dataset near point
F10 F10 toggle-log
toggle ESS[SAS] for .log files; may be useful for
certain debugging situations
F11 F11 filetype-2
switch buffer to filetype-2 (defaults to .dat) file
and `refresh'
F12 F12 viewgraph
open a GSASFILE near point for viewing either in emacs
or with an external viewer
C-F1 C-F1 rtf-portrait
create an MS RTF portrait file from the current buffer
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
C-F3 C-F8 submit-region C-c C-r
write region to ess-temp.sas and submit
C-F5 C-F6 append-to-log
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
C-F9 C-F9 INSIGHT
open an interactive INSIGHT session on the SAS
dataset near point
C-F10 C-F10 kill-em-all
kill all buffers associated with a .sas program
</pre>
<p>SUBMIT, PROGRAM, LOG and OUTPUT need no further explanation since
they mimic the SAS Display Manager function key definitions. However, six
other keys have been provided for convenience and are described below.
<p>`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 buffer-local
variable 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.
<p>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
LOG, OUTPUT, `filetype-1' or F11 are pressed.
<p>`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 file:
<pre class="example"> (setq ess-sas-suffix-1 "csv") ; for example
</pre>
<p>F9 will prompt you for the name of a permanent SAS dataset near point to
be opened for viewing by PROC FSEDIT. You can control the SAS batch
command-line with ess-sas-data-view-submit-options. For controlling the
SAS batch commands, you have the global variables
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 LIBNAMEs defined in autoexec.sas, then the defaults for
these variables should be sufficient.
<p>Similarly, C-F9 will prompt you for the name of a permanent SAS dataset
near point to be opened for viewing by PROC INSIGHT. You can control
the SAS batch command-line with ess-sas-data-view-submit-options. For
controlling the SAS batch commands, you have the global variables
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.
<p>F10 toggles ESS[SAS] mode for .log files which is off by default
(technically, it is 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.
<p>F11 is the same as `filetype-1' except it is .dat by default.
<p>F12 will prompt you for the name of a 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
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.
ess-sas-graph-view-viewer-default is the default external viewer for
your platform. ess-sas-graph-view-viewer-alist is an alist of
exceptions to the default; i.e. file types and their associated
viewers which will be used rather than the default viewer.
<pre class="example"> (setq ess-sas-graph-view-suffix-regexp (concat "[.]\\([eE]?[pP][sS]\\|"
"[pP][dD][fF]\\|[gG][iI][fF]\\|[jJ][pP][eE]?[gG]\\|"
"[tT][iI][fF][fF]?\\)")) ;; default
(setq ess-sas-graph-view-viewer-default "kodakimg") ;; Windows default
(setq ess-sas-graph-view-viewer-default "sdtimage") ;; Solaris default
(setq ess-sas-graph-view-viewer-alist
'(("[eE]?[pP][sS]" . "gv") ("[pP][dD][fF]" . "acroread")) ;; default
</pre>
<p>C-F2 produces US landscape by default, however, it can produce A4
landscape (first line for "global" key mapping, second for "local"):
<pre class="example"> (global-set-key [(control f2)] 'ess-sas-rtf-a4-landscape)
(define-key sas-mode-local-map [(control f2)] 'ess-sas-rtf-a4-landscape)
</pre>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="iESS(SAS)--Interactive-SAS-processes"></a>
<a name="iESS_0028SAS_0029_002d_002dInteractive-SAS-processes"></a>
nächstes: <a rel="next" accesskey="n" href="#iESS_0028SAS_0029_002d_002dCommon-problems">iESS(SAS)--Common problems</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS_0028SAS_0029_002d_002dFunction-keys-for-batch-processing">ESS(SAS)--Function keys for batch processing</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-SAS">ESS for SAS</a>
</div>
<h3 class="section">10.6 iESS[SAS]–Interactive SAS processes</h3>
<p>iESS (inferior ESS) is the method for interfacing with interactive
statistical processes (programs). iESS[SAS] is what is needed for
interactive SAS programming. iESS[SAS] works best
with the following settings for SAS command-line options
(the default of inferior-SAS-args):
<pre class="example"> -stdio -linesize 80 -noovp -nosyntaxcheck
</pre>
<pre class="display"> -stdio
required to make the redirection of stdio work
-linesize 80
keeps output lines from folding on standard terminals
-noovp
prevents error messages from printing 3 times
-nosyntaxcheck
permits recovery after syntax errors
</pre>
<p>To start up iESS[SAS] mode, use:
<pre class="example"> M-x SAS
</pre>
<p>The *SAS:1.log* buffer in ESStr mode corresponds to the file
myfile.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.
<p>The *SAS:1.lst* buffer in ESSlst mode corresponds to the file
myfile.lst in SAS batch usage and to the "SAS: OUTPUT" window in the
SAS Display Manager. All data related printed output from the
PROCs appear in this window.
<p>The iESS [SAS:1] buffer exists solely as a communications buffer.
Files are edited in the myfile.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 the 'Local' 'Submit' menu
commands. The user should never use this buffer directly.
<p>For example, open the file you want to work with.
<pre class="example"> C-x C-f myfile.sas
</pre>
<p>myfile.sas will be in ESS[SAS] mode. Edit as appropriate, and then start
up SAS with the cursor in the myfile.sas buffer.
<pre class="example"> M-x SAS
</pre>
<p>Four buffers will appear on screen:
<pre class="example"> Buffer Mode Description
myfile.sas ESS[SAS] your source file
*SAS:1* iESS [SAS:1] ESS communication buffer
*SAS:1.log* Shell [] ESStr SAS log information
*SAS:1.lst* Shell [] ESSlst SAS listing information
</pre>
<p>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 myfile.sas. Enter the
sequence:
<pre class="example"> C-c C-w
</pre>
<p>The cursor will normally be in buffer myfile.sas.
If not, put it there:
<pre class="example"> C-x b myfile.sas
</pre>
<p>Send regions, lines, or the entire file contents to SAS
(regions are most useful). A highlighted region will normally
begin with the keywords 'DATA' or 'PROC' and end with the
keyword 'RUN;'
<pre class="example"> C-c C-r
</pre>
<p>Information appears in the log buffer, analysis results in the
listing buffer. In case of errors, make the corrections in the
myfile.sas buffer and resubmit with another C-c C-r
<p>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 myfile.log and myfile.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.
<p>At the end of the session, the input file myfile.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.
<p>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!
<!-- DANGER Will Robinson! -->
<!-- We plan to add -->
<!-- @display -->
<!-- The ability to request help from a process for variables and -->
<!-- functions, and to have the results sent into a separate buffer. -->
<!-- completion of object names and file names. -->
<!-- @end display -->
<p>Troubleshooting: Siehe <a href="#iESS_0028SAS_0029_002d_002dCommon-problems">iESS(SAS)–Common problems</a>.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="iESS(SAS)--Common-problems"></a>
<a name="iESS_0028SAS_0029_002d_002dCommon-problems"></a>
nächstes: <a rel="next" accesskey="n" href="#ESS_0028SAS_0029_002d_002dGraphics">ESS(SAS)--Graphics</a>,
voriges: <a rel="previous" accesskey="p" href="#iESS_0028SAS_0029_002d_002dInteractive-SAS-processes">iESS(SAS)--Interactive SAS processes</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-SAS">ESS for SAS</a>
</div>
<h3 class="section">10.7 iESS[SAS]–Common problems</h3>
<pre class="display"> 1. iESS[SAS] does not work on Windows. In order to run SAS inside
an emacs buffer, it is necessary to start SAS with the -stdio option.
SAS does not support the -stdio option on Windows.
2. If M-x SAS gives errors upon startup, check the following:
- you are running Windows: see 1.
- ess-sas-sh-command (in the ESS source directory) needs to be
executable (solution: "chmod ugo+rx ess-sas-sh-command").
- sas isn't in your executable path (verify using "which sas" from
a shell command-line)
3. M-x SAS starts SAS Display Manager. Probably, the command "sas"
on your system calls a shell script. Specify the path to the real
"sas" executable in the file ess-sas-sh-command, i.e.:
<pre class="example"> /usr/local/sas612/sas </dev/tty 1>$stdout 2>$stderr $@
</pre>
<p>To find the "sas" exectuable, you can execute the unix command:
<pre class="example"> find / -name sas -print
</pre>
</pre>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS(SAS)--Graphics"></a>
<a name="ESS_0028SAS_0029_002d_002dGraphics"></a>
nächstes: <a rel="next" accesskey="n" href="#ESS_0028SAS_0029_002d_002dMS-Windows">ESS(SAS)--MS Windows</a>,
voriges: <a rel="previous" accesskey="p" href="#iESS_0028SAS_0029_002d_002dCommon-problems">iESS(SAS)--Common problems</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-SAS">ESS for SAS</a>
</div>
<h3 class="section">10.8 ESS[SAS]–Graphics</h3>
<p>Output from GPROCs can be displayed in a SAS/Graph window for SAS batch
on Windows or for both SAS batch and interactive with X11 on Unix. If
you need to create graphics files and view them with F12, then include
the following (either in myfile.sas or in your autoexec.sas):
<pre class="example"> filename gsasfile 'graphics.ps';
goptions device=ps gsfname=gsasfile gsfmode=append;
</pre>
<p>PROC PLOT graphs can be viewed in the listing buffer. You may
wish to control the vertical spacing to allow the entire plot
to be visible on screen, for example:
<pre class="example"> proc plot;
plot a*b / vpos=25;
run;
</pre>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS(SAS)--MS-Windows"></a>
<a name="ESS_0028SAS_0029_002d_002dMS-Windows"></a>
voriges: <a rel="previous" accesskey="p" href="#ESS_0028SAS_0029_002d_002dGraphics">ESS(SAS)--Graphics</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-SAS">ESS for SAS</a>
</div>
<h3 class="section">10.9 ESS[SAS]–MS Windows</h3>
<ul>
<li>iESS[SAS] does not work on Windows. Siehe <a href="#iESS_0028SAS_0029_002d_002dCommon-problems">iESS(SAS)–Common problems</a>.
<li>ESS[SAS] mode for editing SAS language files works very well.
Siehe <a href="#ESS_0028SAS_0029_002d_002dEditing-files">ESS(SAS)–Editing files</a>.
<li>There are two execution options for SAS on Windows.
You can use batch. Siehe <a href="#ESS_0028SAS_0029_002d_002dBatch-SAS-processes">ESS(SAS)–Batch SAS processes</a>.
<p>Or you can mark regions with the mouse and submit the code with
`submit-region' or paste them into SAS Display Manager.
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS-for-BUGS"></a>
nächstes: <a rel="next" accesskey="n" href="#Miscellaneous">Miscellaneous</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS-for-SAS">ESS for SAS</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">11 ESS for BUGS</h2>
<ul class="menu">
<li><a accesskey="1" href="#ESS_0028BUGS_0029_002d_002dModel-files">ESS(BUGS)--Model files</a>
<li><a accesskey="2" href="#ESS_0028BUGS_0029_002d_002dCommand-files">ESS(BUGS)--Command files</a>
<li><a accesskey="3" href="#ESS_0028BUGS_0029_002d_002dLog-files">ESS(BUGS)--Log files</a>
</ul>
<p>ESS[BUGS] was designed for use with BUGS software. It was developed by
Rodney A. Sparapani and has some similarities with ESS[SAS].
ESS facilitates BUGS batch with ESS[BUGS], the mode for files with the .bug
extension. ESS provides 5 features. First, BUGS syntax is described to allow
for proper fontification of statements, distributions, functions, commands and
comments in BUGS model files, command files and log files. Second,
ESS creates templates for the command file from the model file so that
a BUGS batch process can be defined by a single file. Third, ESS
provides a BUGS batch script that allows ESS to set BUGS batch
parameters. Fourth, key sequences are defined to create a command
file and submit a BUGS batch process. Lastly, interactive submission of BUGS
commands is also supported.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS(BUGS)--Model-files"></a>
<a name="ESS_0028BUGS_0029_002d_002dModel-files"></a>
nächstes: <a rel="next" accesskey="n" href="#ESS_0028BUGS_0029_002d_002dCommand-files">ESS(BUGS)--Command files</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS-for-BUGS">ESS for BUGS</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-BUGS">ESS for BUGS</a>
</div>
<h3 class="section">11.1 ESS[BUGS]–Model files</h3>
<p>Model files (with the .bug extension) are edited in ESS[BUGS] mode. Two keys
are bound for your use in ESS[BUGS], F2 and F12. F2 performs the same action
as it does in ESS[SAS], Siehe <a href="#ESS_0028SAS_0029_002d_002dFunction-keys-for-batch-processing">ESS(SAS)–Function keys for batch processing</a>.
F12 performs the function
ess-bugs-next-action which you will use a lot. Pressing F12 in an empty buffer
for a model file will produce a template for you.
<p>ESS[BUGS] supports "replacement" variables. These variables are created as
part of the template, i.e. with the first press of F12 in an empty buffer.
They are named by
all capitals and start with '%': %N, %DATA, %INIT, %MONITOR and %STATS.
When you are finished editing your model file, pressing F12 will perform the
necessary replacements and build your command file for you.
<p>The %DATA variable appears in
the line 'data in "%DATA";'. On the second press of F12, %DATA will be
replaced by the model file name except it will have the .dat extension. If
your data file is named something else, then change %DATA in the template to
the appropriate file name and no replacement will occur.
<p>The %INIT variable appears in
the line 'inits in "%INIT";'. On the second press of F12, %INIT will be
replaced by the model file name except it will have the .in extension. If
your model will be generating it's own initial values, place a comment
character, #, at the beginning of the line. Or, if your
init file is named something else, then change %INIT in the template to the
appropriate file name.
<p>The %N variable appears in the line 'const N = 0;#%N'. Although it is commented,
it is still active. Notice that later on in the template you have the line
'for (i in 1:N)'. The BUGS constant N is the number of rows in
your data file. When you press F12, the data file is read and the number of
lines are counted (after %DATA is resolved, if necessary). The number of
lines replace the zero in the 'const N = 0' statement.
<p>The %MONITOR variable appears on a line by itself. Although it is commented,
it is still active. This line is a list of variables that you want monitored.
When you press F12, the appropriate statements are created in
the command file to monitor the list of variables. If the line is blank, then
the list is populated with the variables from the 'var' statement.
<p>The %STATS variable is similar to the %MONITOR variable. It is a list of
variables for which summary statistics will be calculated. When you press
F12, the appropriate statements will be generated in your command file.
<p>Please note that the %DATA and %INIT variables are only replaced on the second
press of F12, but the actions for %N, %MONITOR and %STATS are performed on
each press of F12 if you re-visit the model file.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS(BUGS)--Command-files"></a>
<a name="ESS_0028BUGS_0029_002d_002dCommand-files"></a>
nächstes: <a rel="next" accesskey="n" href="#ESS_0028BUGS_0029_002d_002dLog-files">ESS(BUGS)--Log files</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS_0028BUGS_0029_002d_002dModel-files">ESS(BUGS)--Model files</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-BUGS">ESS for BUGS</a>
</div>
<h3 class="section">11.2 ESS[BUGS]–Command files</h3>
<p>To avoid extension name collision, .bmd is used for BUGS command files. When
you have finished editing your model file and press F12, a command file is
created if one does not already exist. However, the command file was
created, it recognizes two "replacement" variables: %MONITOR and %STATS.
<p>Two %MONITOR variables appears on lines by themselves. Although they are
commented, they are still active. Between them appears the necessary
statements to monitor the list of variables specified in the model file. The
behavior of the %STATS variable is similar.
<p>When you are finished editing your command file, pressing F12 again will submit
your command file as a batch job. Batch scripts are provided for both DOS and
Unix in the etc sub-directory of the ESS distribution. The DOS script is
called "BACKBUGS.BAT" and the Unix script is "backbugs". These scripts allow
you to change the number of bins to use in the Griddy algorithm
(Metropolis sampling). That is handled by the variable ess-bugs-default-bins
which defaults to 32.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="ESS(BUGS)--Log-files"></a>
<a name="ESS_0028BUGS_0029_002d_002dLog-files"></a>
voriges: <a rel="previous" accesskey="p" href="#ESS_0028BUGS_0029_002d_002dCommand-files">ESS(BUGS)--Command files</a>,
aufwärts: <a rel="up" accesskey="u" href="#ESS-for-BUGS">ESS for BUGS</a>
</div>
<h3 class="section">11.3 ESS[BUGS]–Log files</h3>
<p>To avoid extension name collision, .bog is used for BUGS log files. The BUGS
batch script provided with ESS creates the .bog file from the .log file when
the batch process completes. If you need to look at the .log file while
the batch process is running, it will not appear in ESS[BUGS] mode unless
you modify the auto-mode-alist variable. If you have done so, then you
may find F2 useful to refresh the .log if the batch process over-writes or
appends it.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Miscellaneous"></a>
nächstes: <a rel="next" accesskey="n" href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>,
voriges: <a rel="previous" accesskey="p" href="#ESS-for-BUGS">ESS for BUGS</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">12 Other features of ESS</h2>
<p>ESS has a few miscellaneous features, which didn't fit anywhere else.
<ul class="menu">
<li><a accesskey="1" href="#Highlighting">Highlighting</a>: Syntactic highlighting of buffers
<li><a accesskey="2" href="#Graphics">Graphics</a>: Using graphics with ESS
<li><a accesskey="3" href="#Imenu">Imenu</a>: Support for Imenu in ESS
<li><a accesskey="4" href="#Toolbar">Toolbar</a>: Support for toolbar in ESS
<li><a accesskey="5" href="#TAGS">TAGS</a>: Using TAGS for S files
<li><a accesskey="6" href="#Rdired">Rdired</a>: Directory editor for R objects
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Highlighting"></a>
nächstes: <a rel="next" accesskey="n" href="#Graphics">Graphics</a>,
voriges: <a rel="previous" accesskey="p" href="#Miscellaneous">Miscellaneous</a>,
aufwärts: <a rel="up" accesskey="u" href="#Miscellaneous">Miscellaneous</a>
</div>
<h3 class="section">12.1 Syntactic highlighting of buffers</h3>
<p>ESS provides Font-Lock (see <a href="emacs.html#Faces">Using Multiple Typefaces</a>) patterns for Inferior S Mode, S
Mode, and S Transcript Mode buffers.
<a name="index-Font_002dlock-mode-195"></a><a name="index-highlighting-196"></a>
To activate highlighting, you need to turn on Font Lock mode in the
appropriate buffers. This can be done on a per-buffer basis with
<kbd>M-x font-lock-mode</kbd>, or may be done by adding
<code>turn-on-font-lock</code> to <code>inferior-ess-mode-hook</code>,
<code>ess-mode-hook</code> and <code>ess-transcript-mode-hook</code>. Your systems
administrator may have done this for you in <samp><span class="file">ess-site.el</span></samp>
(see <a href="#Customization">Customization</a>).
<p>The font-lock patterns are defined in three variables, which you may
modify if desired:
<div class="defun">
— Variable: <b>inferior-ess-font-lock-keywords</b><var><a name="index-inferior_002dess_002dfont_002dlock_002dkeywords-197"></a></var><br>
<blockquote><p>Font-lock patterns for Inferior ESS Mode. The default value
highlights prompts, inputs, assignments, output messages, vector and
matrix labels, and literals such as `<samp><span class="samp">NA</span></samp>' and <code>TRUE</code>.
</p></blockquote></div>
<div class="defun">
— Variable: <b>ess-mode-font-lock-keywords</b><var><a name="index-ess_002dmode_002dfont_002dlock_002dkeywords-198"></a></var><br>
<blockquote><p>Font-lock patterns for ESS programming mode. The default value
highlights function names, literals, assignments, source functions and
reserved words.
</p></blockquote></div>
<div class="defun">
— Variable: <b>ess-trans-font-lock-keywords</b><var><a name="index-ess_002dtrans_002dfont_002dlock_002dkeywords-199"></a></var><br>
<blockquote><p>Font-lock patterns for ESS Transcript Mode. The default value
highlights the same patterns as in Inferior ESS Mode.
</p></blockquote></div>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Graphics"></a>
nächstes: <a rel="next" accesskey="n" href="#Imenu">Imenu</a>,
voriges: <a rel="previous" accesskey="p" href="#Highlighting">Highlighting</a>,
aufwärts: <a rel="up" accesskey="u" href="#Miscellaneous">Miscellaneous</a>
</div>
<h3 class="section">12.2 Using graphics with ESS</h3>
<p><a name="index-graphics-200"></a>One of the main features of the <code>S</code> package is its ability to
generate high-resolution graphics plots, and ESS provides a number of
features for dealing with such plots.
<ul class="menu">
<li><a accesskey="1" href="#printer">printer</a>: The printer() graphics driver
<li><a accesskey="2" href="#X11">X11</a>: The X11() (and other X-windows based) driver
<li><a accesskey="3" href="#winjava">winjava</a>: Java Graphics Device
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="printer"></a>
nächstes: <a rel="next" accesskey="n" href="#X11">X11</a>,
voriges: <a rel="previous" accesskey="p" href="#Graphics">Graphics</a>,
aufwärts: <a rel="up" accesskey="u" href="#Graphics">Graphics</a>
</div>
<h4 class="subsection">12.2.1 Using ESS with the <code>printer()</code> driver</h4>
<p>This is the simplest (and least desirable) method of using graphics
within ESS. S's <code>printer()</code> device driver produces crude character
based plots which can be contained within the ESS process buffer
itself. To start using character graphics, issue the S command
<pre class="example"> printer(width=79)
</pre>
<p><a name="index-printer_0028_0029-201"></a>(the <code>width=79</code> argument prevents Emacs line-wrapping at column
80 on an 80-column terminal. Use a different value for a terminal with
a different number of columns.) Plotting commands do not generate
graphics immediately, but are stored until the <code>show()</code> command
is issued, which displays the current figure.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="X11"></a>
nächstes: <a rel="next" accesskey="n" href="#winjava">winjava</a>,
voriges: <a rel="previous" accesskey="p" href="#printer">printer</a>,
aufwärts: <a rel="up" accesskey="u" href="#Graphics">Graphics</a>
</div>
<h4 class="subsection">12.2.2 Using ESS with windowing devices</h4>
<p><a name="index-X-windows-202"></a>Of course, the ideal way to use graphics with ESS is to use a windowing
system. Under X11, this requires that the DISPLAY environment
variable be appropriately set, which may not always be the case within
your Emacs process. ESS provides a facility for setting the value of
DISPLAY before the ESS process is started if the variable
<code>ess-ask-about-display</code>
<a name="index-ess_002dask_002dabout_002ddisplay-203"></a>is non-<code>nil</code>.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="winjava"></a>
voriges: <a rel="previous" accesskey="p" href="#X11">X11</a>,
aufwärts: <a rel="up" accesskey="u" href="#Graphics">Graphics</a>
</div>
<h4 class="subsection">12.2.3 Java Graphics Device</h4>
<p><a name="index-winjava-204"></a>
S+6.1 and newer on Windows contains a java library that supports graphics. Send
the commands:
<pre class="example"> library(winjava)
java.graph()
</pre>
<p class="noindent">to start the graphics driver. This allows you to use ESS for both
interaction and graphics within S-PLUS. (Thanks to Tim Hesterberg for
this information.)
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Imenu"></a>
nächstes: <a rel="next" accesskey="n" href="#Toolbar">Toolbar</a>,
voriges: <a rel="previous" accesskey="p" href="#Graphics">Graphics</a>,
aufwärts: <a rel="up" accesskey="u" href="#Miscellaneous">Miscellaneous</a>
</div>
<h3 class="section">12.3 Imenu</h3>
<p>Imenu is an Emacs tool for providing mode-specific buffer indexes. In
some of the ESS editing modes (currently SAS and S), support for Imenu
is provided. For example, in S mode buffers, the menubar should display
an item called "Imenu-S". Within this menubar you will then be offered
bookmarks to particular parts of your source file (such as the starting
point of each function definition).
<p>Imenu works by searching your buffer for lines that match what ESS
thinks is the beginning of a suitable entry, e.g. the beginning of a
function definition. To examine the regular expression that ESS uses,
check the value of <code>imenu-generic-expression</code>. This value is set
by various ESS variables such as <code>ess-imenu-S-generic-expression</code>.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Toolbar"></a>
nächstes: <a rel="next" accesskey="n" href="#TAGS">TAGS</a>,
voriges: <a rel="previous" accesskey="p" href="#Imenu">Imenu</a>,
aufwärts: <a rel="up" accesskey="u" href="#Miscellaneous">Miscellaneous</a>
</div>
<h3 class="section">12.4 Toolbar</h3>
<p>The R and S editing modes have support for a toolbar. This toolbar
provides icons to act as shortcuts for starting new S/R processes, or
for evaluating regions of your source buffers. The toolbar should be
present if your emacs can display images. Siehe <a href="#Customization">Customization</a>, for ways
to change the toolbar.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="TAGS"></a>
nächstes: <a rel="next" accesskey="n" href="#Rdired">Rdired</a>,
voriges: <a rel="previous" accesskey="p" href="#Toolbar">Toolbar</a>,
aufwärts: <a rel="up" accesskey="u" href="#Miscellaneous">Miscellaneous</a>
</div>
<h3 class="section">12.5 TAGS</h3>
<p>The Emacs tags facility can be used to navigate around your files
containing definitions of S functions. This facility is independent of
ESS usage, but is written here since ESS users may wish to take
advantage of TAGS facility. Read more about emacs tags in an emacs
manual.
<p>Etags, the program that generates the TAGS file, does not yet know the
syntax to recognise function definitions in S files. Hence, you will
need to provide a regexp that matches your function definitions. Here
is an example call (broken over two lines; type as one line) that should
be appropriate.
<pre class="example"> etags --language=none
--regex='/\([^ \t]+\)[ \t]*<-[ \t]*function/\1/' *.R
</pre>
<p>This will find entries in your source file of the form:
<pre class="example"> some.name <- function
</pre>
<p>with the function name starting in column 0. Windows users may need to
change the single quotes to double quotes.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Rdired"></a>
voriges: <a rel="previous" accesskey="p" href="#TAGS">TAGS</a>,
aufwärts: <a rel="up" accesskey="u" href="#Miscellaneous">Miscellaneous</a>
</div>
<h3 class="section">12.6 Rdired</h3>
<p>Ess-rdired provides a dired-like buffer for viewing, editing and
plotting objects in your current R session. If you are used to using
the dired (directory editor) facility in Emacs, this mode gives you
similar functionality for R objects.
<p>To get started, first make sure you can load ess-rdired. Add the
following to your .emacs and then restart emacs.
<pre class="example"> (autoload 'ess-rdired "ess-rdired"
"View *R* objects in a dired-like buffer." t)
</pre>
<p>Start an R session with <kbd>M-x R</kbd> and then store a few
variables, such as:
<pre class="example"> s <- sin(seq(from=0, to=8*pi, length=100))
x <- c(1, 4, 9)
y <- rnorm(20)
z <- TRUE
</pre>
<p>Then use <kbd>M-x ess-rdired</kbd> to create a buffer listing the
objects in your current environment and display it in a new window:
<pre class="example"> mode length
s numeric 100
x numeric 3
y numeric 20
z logical 1
</pre>
<p>Type <kbd>C-h m</kbd> or <kbd>?</kbd> to get a list of the keybindings for this
mode. For example, with your point on the line of a variable, `p' will
plot the object, `v' will view it, and `d' will mark the object for
deletion (`x' will actually perform the deletion).
<!-- node-name, next, previous, up@chapter Using S4 -->
<div class="node">
<p><hr>
<a name="Mailing-lists%2fbug-reports"></a>
<a name="Mailing-lists_002fbug-reports"></a>
nächstes: <a rel="next" accesskey="n" href="#Customization">Customization</a>,
voriges: <a rel="previous" accesskey="p" href="#Miscellaneous">Miscellaneous</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">13 Bugs and Bug Reporting, Mailing Lists</h2>
<ul class="menu">
<li><a accesskey="1" href="#Bugs">Bugs</a>
<li><a accesskey="2" href="#Reporting-Bugs">Reporting Bugs</a>
<li><a accesskey="3" href="#Mailing-Lists">Mailing Lists</a>
</ul>
<div class="node">
<p><hr>
<a name="Bugs"></a>
nächstes: <a rel="next" accesskey="n" href="#Reporting-Bugs">Reporting Bugs</a>,
voriges: <a rel="previous" accesskey="p" href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>,
aufwärts: <a rel="up" accesskey="u" href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>
</div>
<h3 class="section">13.1 Bugs</h3>
<p><a name="index-bugs-205"></a>
<ul>
<li>Commands like <code>ess-display-help-on-object</code> and list completion
cannot be used while the user is entering a multi-line command. The
only real fix in this situation is to use another ESS process.
<li>The <code>ess-eval-</code> commands can leave point in the ESS process
buffer in the wrong place when point is at the same position as the last
process output. This proves difficult to fix, in general, as we need to
consider all <em>windows</em> with <code>window-point</code> at the right place.
<li>It's possible to clear the modification flag (say, by saving the buffer)
with the edit buffer not having been loaded into S.
<li>Backup files can sometimes be left behind, even when
<code>ess-keep-dump-files</code> is <code>nil</code>.
<li>Passing an incomplete S expression to <code>ess-execute</code> causes ESS
to hang.
<li>The function-based commands don't always work as expected on functions
whose body is not a parenthesized or compound expression, and don't even
recognize anonymous functions (i.e. functions not assigned to any
variable).
<li>Multi-line commands could be handled better by the command history
mechanism.
</ul>
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Reporting-Bugs"></a>
nächstes: <a rel="next" accesskey="n" href="#Mailing-Lists">Mailing Lists</a>,
voriges: <a rel="previous" accesskey="p" href="#Bugs">Bugs</a>,
aufwärts: <a rel="up" accesskey="u" href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>
</div>
<h3 class="section">13.2 Reporting Bugs</h3>
<p><a name="index-Bug-reports-206"></a><a name="index-ess_002dsubmit_002dbug_002dreport-207"></a>
<p>Please send bug reports, suggestions etc. to
<p><A HREF="mailto:ESS-bugs@stat.math.ethz.ch">
<a href="mailto:ESS-bugs@stat.math.ethz.ch">ESS-bugs@stat.math.ethz.ch</a>
</A>
<p>The easiest way to do this is within Emacs by typing
<p><kbd>M-x ess-submit-bug-report</kbd>
<p>This also gives the maintainers valuable information about your
installation which may help us to identify or even fix the bug.
<p>If Emacs reports an error, backtraces can help us debug the problem.
Type "M-x set-variable RET debug-on-error RET t RET". Then run the
command that causes the error and you should see a *Backtrace* buffer
containing debug information; send us that buffer.
<p>Note that comments, suggestions, words of praise and large cash
donations are also more than welcome.
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Mailing-Lists"></a>
voriges: <a rel="previous" accesskey="p" href="#Reporting-Bugs">Reporting Bugs</a>,
aufwärts: <a rel="up" accesskey="u" href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>
</div>
<h3 class="section">13.3 Mailing Lists</h3>
<p>There is a mailing list for discussions and announcements relating to
ESS. Join the list by sending an e-mail with "subscribe ess-help" (or
"help") in the body to <a href="mailto:ess-help-request@stat.math.ethz.ch">ess-help-request@stat.math.ethz.ch</a>;
contributions to the list may be mailed to
<a href="mailto:ess-help@stat.math.ethz.ch">ess-help@stat.math.ethz.ch</a>. Rest assured, this is a fairly
low-volume mailing list.
<p>The purposes of the mailing list include
<ul>
<li> helping users of ESS to get along with it.
<li> discussing aspects of using ESS on Emacs and XEmacs.
<li> suggestions for improvements.
<li> announcements of new releases of ESS.
<li> posting small patches to ESS.
</ul>
<!-- _not_yet_ @node Help OS, Installation, Help for Statistical Packages, Top -->
<!-- _not_yet_ @comment node-name, next, previous, up -->
<!-- _not_yet_ @chapter Help, arranged by Operating System -->
<!-- _not_yet_ -->
<!-- _not_yet_ @menu -->
<!-- _not_yet_ * Unix installation:: -->
<!-- _not_yet_ * Microsoft Windows installation:: -->
<!-- _not_yet_ * System dependent:: Other variables you may need to change -->
<!-- _not_yet_ @end menu -->
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Customization"></a>
nächstes: <a rel="next" accesskey="n" href="#Key-Index">Key Index</a>,
voriges: <a rel="previous" accesskey="p" href="#Mailing-lists_002fbug-reports">Mailing lists/bug reports</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="appendix">Anhang A Customizing ESS</h2>
<p><a name="index-customization-208"></a>
ESS can be easily customized to your taste simply by including the
appropriate lines in your <samp><span class="file">.emacs</span></samp> 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
available.
<p>Most of these variables can be viewed and set using the Custom facility
within Emacs. Type <kbd>M-x customize-group RET ess RET</kbd> to see all the
ESS variables that can be customized. Variables are grouped by subject
to make it easy to find related variables.
<!-- Stephen deleted incomplete variable list Wed 25 Aug 2004. -->
<div class="node">
<p><hr>
<a name="Key-Index"></a>
nächstes: <a rel="next" accesskey="n" href="#Concept-Index">Concept Index</a>,
voriges: <a rel="previous" accesskey="p" href="#Customization">Customization</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="unnumbered">Key (Character) Index</h2>
<ul class="index-ky" compact>
</ul><!-- @node Command Index, Concept Index, Key Index, Top -->
<!-- @unnumbered Command and Function Index -->
<!-- @printindex fn -->
<!-- node-name, next, previous, up -->
<div class="node">
<p><hr>
<a name="Concept-Index"></a>
nächstes: <a rel="next" accesskey="n" href="#Variable-and-command-index">Variable and command index</a>,
voriges: <a rel="previous" accesskey="p" href="#Key-Index">Key Index</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="unnumbered">Concept Index</h2>
<ul class="index-cp" compact>
<li><a href="#index-g_t_0040file_007b_002eemacs_007d-file-176"><samp><span class="file">.emacs</span></samp> file</a>: <a href="#Source-Directories">Source Directories</a></li>
<li><a href="#index-g_t_0040file_007b_002eemacs_007d-file-159"><samp><span class="file">.emacs</span></samp> file</a>: <a href="#Indenting">Indenting</a></li>
<li><a href="#index-aborting-S-commands-111">aborting S commands</a>: <a href="#Other">Other</a></li>
<li><a href="#index-aborting-the-ESS-process-116">aborting the ESS process</a>: <a href="#Other">Other</a></li>
<li><a href="#index-arguments-to-S-program-31">arguments to S program</a>: <a href="#Customizing-startup">Customizing startup</a></li>
<li><a href="#index-authors-7">authors</a>: <a href="#Credits">Credits</a></li>
<li><a href="#index-autosaving-171">autosaving</a>: <a href="#Source-Files">Source Files</a></li>
<li><a href="#index-Bug-reports-206">Bug reports</a>: <a href="#Reporting-Bugs">Reporting Bugs</a></li>
<li><a href="#index-bugs-205">bugs</a>: <a href="#Bugs">Bugs</a></li>
<li><a href="#index-cleaning-up-104">cleaning up</a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-comint-6">comint</a>: <a href="#Credits">Credits</a></li>
<li><a href="#index-command-history-72">command history</a>: <a href="#Command-History">Command History</a></li>
<li><a href="#index-command_002dline-completion-41">command-line completion</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-command_002dline-editing-35">command-line editing</a>: <a href="#Command_002dline-editing">Command-line editing</a></li>
<li><a href="#index-commands-33">commands</a>: <a href="#Entering-commands">Entering commands</a></li>
<li><a href="#index-comments-168">comments</a>: <a href="#Source-Files">Source Files</a></li>
<li><a href="#index-comments-in-S-154">comments in S</a>: <a href="#Indenting">Indenting</a></li>
<li><a href="#index-completion-in-edit-buffer-162">completion in edit buffer</a>: <a href="#Other-edit-buffer-commands">Other edit buffer commands</a></li>
<li><a href="#index-completion-of-object-names-40">completion of object names</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-completion-on-file-names-49">completion on file names</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-completion-on-lists-48">completion on lists</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-completion_002c-when-prompted-for-object-names-125">completion, when prompted for object names</a>: <a href="#Edit-buffer">Edit buffer</a></li>
<li><a href="#index-creating-new-objects-126">creating new objects</a>: <a href="#Edit-buffer">Edit buffer</a></li>
<li><a href="#index-credits-8">credits</a>: <a href="#Credits">Credits</a></li>
<li><a href="#index-customization-208">customization</a>: <a href="#Customization">Customization</a></li>
<li><a href="#index-data-frames-45">data frames</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-debugging-S-functions-152">debugging S functions</a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-deleting-output-59">deleting output</a>: <a href="#Last-command">Last command</a></li>
<li><a href="#index-directories-16">directories</a>: <a href="#Starting-up">Starting up</a></li>
<li><a href="#index-dump-file-directories-174">dump file directories</a>: <a href="#Source-Directories">Source Directories</a></li>
<li><a href="#index-dump-file-names-172">dump file names</a>: <a href="#Source-Directories">Source Directories</a></li>
<li><a href="#index-dump-files-165">dump files</a>: <a href="#Source-Files">Source Files</a></li>
<li><a href="#index-dump-files-129">dump files</a>: <a href="#Edit-buffer">Edit buffer</a></li>
<li><a href="#index-echoing-commands-when-evaluating-139">echoing commands when evaluating</a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-edit-buffer-123">edit buffer</a>: <a href="#Edit-buffer">Edit buffer</a></li>
<li><a href="#index-editing-commands-73">editing commands</a>: <a href="#Command-History">Command History</a></li>
<li><a href="#index-editing-functions-122">editing functions</a>: <a href="#Editing">Editing</a></li>
<li><a href="#index-editing-transcripts-70">editing transcripts</a>: <a href="#Saving-transcripts">Saving transcripts</a></li>
<li><a href="#index-emacsclient-109">emacsclient</a>: <a href="#Emacsclient">Emacsclient</a></li>
<li><a href="#index-entering-commands-32">entering commands</a>: <a href="#Entering-commands">Entering commands</a></li>
<li><a href="#index-errors-134">errors</a>: <a href="#Error-Checking">Error Checking</a></li>
<li><a href="#index-ESS-process-buffer-17">ESS process buffer</a>: <a href="#Starting-up">Starting up</a></li>
<li><a href="#index-ESS-process-directory-13">ESS process directory</a>: <a href="#Starting-up">Starting up</a></li>
<li><a href="#index-evaluating-code-with-echoed-commands-140">evaluating code with echoed commands</a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-evaluating-S-expressions-141">evaluating S expressions</a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-Font_002dlock-mode-195">Font-lock mode</a>: <a href="#Highlighting">Highlighting</a></li>
<li><a href="#index-formatting-source-code-158">formatting source code</a>: <a href="#Indenting">Indenting</a></li>
<li><a href="#index-graphics-200">graphics</a>: <a href="#Graphics">Graphics</a></li>
<li><a href="#index-help-files-181">help files</a>: <a href="#Help">Help</a></li>
<li><a href="#index-highlighting-196">highlighting</a>: <a href="#Highlighting">Highlighting</a></li>
<li><a href="#index-historic-backups-170">historic backups</a>: <a href="#Source-Files">Source Files</a></li>
<li><a href="#index-hot-keys-93">hot keys</a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-indenting-157">indenting</a>: <a href="#Indenting">Indenting</a></li>
<li><a href="#index-installation-9">installation</a>: <a href="#Installation">Installation</a></li>
<li><a href="#index-interactive-use-of-S-2">interactive use of S</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-interrupting-S-commands-112">interrupting S commands</a>: <a href="#Other">Other</a></li>
<li><a href="#index-introduction-1">introduction</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-keyboard-short-cuts-94">keyboard short cuts</a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-killing-temporary-buffers-106">killing temporary buffers</a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-killing-the-ESS-process-100">killing the ESS process</a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-lists_002c-completion-on-47">lists, completion on</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-motion-in-transcript-mode-119">motion in transcript mode</a>: <a href="#Transcript-Mode">Transcript Mode</a></li>
<li><a href="#index-multi_002dline-commands_002c-resubmitting-67">multi-line commands, resubmitting</a>: <a href="#Transcript-resubmit">Transcript resubmit</a></li>
<li><a href="#index-Multiple-ESS-processes-19">Multiple ESS processes</a>: <a href="#Multiple-ESS-processes">Multiple ESS processes</a></li>
<li><a href="#index-new-objects_002c-creating-127">new objects, creating</a>: <a href="#Edit-buffer">Edit buffer</a></li>
<li><a href="#index-objects-86">objects</a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-pages-in-the-process-buffer-54">pages in the process buffer</a>: <a href="#Transcript">Transcript</a></li>
<li><a href="#index-paging-commands-in-help-buffers-185">paging commands in help buffers</a>: <a href="#Help">Help</a></li>
<li><a href="#index-paragraphs-in-the-process-buffer-53">paragraphs in the process buffer</a>: <a href="#Transcript">Transcript</a></li>
<li><a href="#index-parsing-errors-135">parsing errors</a>: <a href="#Error-Checking">Error Checking</a></li>
<li><a href="#index-process-buffer-18">process buffer</a>: <a href="#Starting-up">Starting up</a></li>
<li><a href="#index-process-names-20">process names</a>: <a href="#Multiple-ESS-processes">Multiple ESS processes</a></li>
<li><a href="#index-programming-in-S-5">programming in S</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-project-work-in-S-169">project work in S</a>: <a href="#Source-Files">Source Files</a></li>
<li><a href="#index-quitting-from-ESS-99">quitting from ESS</a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-re_002dexecuting-commands-74">re-executing commands</a>: <a href="#Command-History">Command History</a></li>
<li><a href="#index-reading-long-command-outputs-56">reading long command outputs</a>: <a href="#Last-command">Last command</a></li>
<li><a href="#index-Remote-Computers-22">Remote Computers</a>: <a href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a></li>
<li><a href="#index-reverting-function-definitions-130">reverting function definitions</a>: <a href="#Edit-buffer">Edit buffer</a></li>
<li><a href="#index-running-S-11">running S</a>: <a href="#Starting-up">Starting up</a></li>
<li><a href="#index-search-list-178">search list</a>: <a href="#Source-Directories">Source Directories</a></li>
<li><a href="#index-search-list-90">search list</a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-sending-input-34">sending input</a>: <a href="#Entering-commands">Entering commands</a></li>
<li><a href="#index-starting-directory-14">starting directory</a>: <a href="#Starting-up">Starting up</a></li>
<li><a href="#index-starting-ESS-10">starting ESS</a>: <a href="#Starting-up">Starting up</a></li>
<li><a href="#index-stepping-through-code-151">stepping through code</a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-STERM-107">STERM</a>: <a href="#Statistical-Process-running-in-ESS_003f">Statistical Process running in ESS?</a></li>
<li><a href="#index-tcsh-43">tcsh</a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-temporary-buffers-194">temporary buffers</a>: <a href="#Help">Help</a></li>
<li><a href="#index-temporary-buffers_002c-killing-105">temporary buffers, killing</a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-transcript-52">transcript</a>: <a href="#Transcript">Transcript</a></li>
<li><a href="#index-transcript-file-29">transcript file</a>: <a href="#Customizing-startup">Customizing startup</a></li>
<li><a href="#index-transcript-file-names-69">transcript file names</a>: <a href="#Saving-transcripts">Saving transcripts</a></li>
<li><a href="#index-transcript-mode-motion-118">transcript mode motion</a>: <a href="#Transcript-Mode">Transcript Mode</a></li>
<li><a href="#index-transcripts-of-S-sessions-4">transcripts of S sessions</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-using-S-interactively-3">using S interactively</a>: <a href="#Introduction">Introduction</a></li>
<li><a href="#index-winjava-204">winjava</a>: <a href="#winjava">winjava</a></li>
<li><a href="#index-working-directory-179">working directory</a>: <a href="#Source-Directories">Source Directories</a></li>
<li><a href="#index-working-directory-15">working directory</a>: <a href="#Starting-up">Starting up</a></li>
<li><a href="#index-X-windows-202">X windows</a>: <a href="#X11">X11</a></li>
</ul><div class="node">
<p><hr>
<a name="Variable-and-command-index"></a>
voriges: <a rel="previous" accesskey="p" href="#Concept-Index">Concept Index</a>,
aufwärts: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="unnumbered">Variable and command index</h2>
<ul class="index-vr" compact>
<li><a href="#index-attach_0028_0029-96"><code>attach()</code></a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-backward_002dkill_002dword-37"><code>backward-kill-word</code></a>: <a href="#Command_002dline-editing">Command-line editing</a></li>
<li><a href="#index-comint_002dbackward_002dmatching_002dinput-62"><code>comint-backward-matching-input</code></a>: <a href="#Process-buffer-motion">Process buffer motion</a></li>
<li><a href="#index-comint_002dbol-39"><code>comint-bol</code></a>: <a href="#Command_002dline-editing">Command-line editing</a></li>
<li><a href="#index-comint_002dcopy_002dold_002dinput-65"><code>comint-copy-old-input</code></a>: <a href="#Transcript-resubmit">Transcript resubmit</a></li>
<li><a href="#index-comint_002ddelimiter_002dargument_002dlist-82"><code>comint-delimiter-argument-list</code></a>: <a href="#History-expansion">History expansion</a></li>
<li><a href="#index-comint_002ddynamic_002dcomplete-42"><code>comint-dynamic-complete</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-comint_002dforward_002dmatching_002dinput-63"><code>comint-forward-matching-input</code></a>: <a href="#Process-buffer-motion">Process buffer motion</a></li>
<li><a href="#index-comint_002dinput_002dring_002dsize-75"><code>comint-input-ring-size</code></a>: <a href="#Command-History">Command History</a></li>
<li><a href="#index-comint_002dinterrupt_002dsubjob-110"><code>comint-interrupt-subjob</code></a>: <a href="#Other">Other</a></li>
<li><a href="#index-comint_002dkill_002dinput-38"><code>comint-kill-input</code></a>: <a href="#Command_002dline-editing">Command-line editing</a></li>
<li><a href="#index-comint_002dkill_002doutput-58"><code>comint-kill-output</code></a>: <a href="#Last-command">Last command</a></li>
<li><a href="#index-comint_002dnext_002dinput-77"><code>comint-next-input</code></a>: <a href="#Command-History">Command History</a></li>
<li><a href="#index-comint_002dnext_002dinput-61"><code>comint-next-input</code></a>: <a href="#Process-buffer-motion">Process buffer motion</a></li>
<li><a href="#index-comint_002dnext_002dmatching_002dinput-79"><code>comint-next-matching-input</code></a>: <a href="#Command-History">Command History</a></li>
<li><a href="#index-comint_002dnext_002dmatching_002dinput_002dfrom_002dinput-81"><code>comint-next-matching-input-from-input</code></a>: <a href="#Command-History">Command History</a></li>
<li><a href="#index-comint_002dprevious_002dinput-76"><code>comint-previous-input</code></a>: <a href="#Command-History">Command History</a></li>
<li><a href="#index-comint_002dprevious_002dinput-60"><code>comint-previous-input</code></a>: <a href="#Process-buffer-motion">Process buffer motion</a></li>
<li><a href="#index-comint_002dprevious_002dmatching_002dinput-78"><code>comint-previous-matching-input</code></a>: <a href="#Command-History">Command History</a></li>
<li><a href="#index-comint_002dprevious_002dmatching_002dinput_002dfrom_002dinput-80"><code>comint-previous-matching-input-from-input</code></a>: <a href="#Command-History">Command History</a></li>
<li><a href="#index-comint_002dshow_002dmaximum_002doutput-55"><code>comint-show-maximum-output</code></a>: <a href="#Last-command">Last command</a></li>
<li><a href="#index-comint_002dshow_002doutput-57"><code>comint-show-output</code></a>: <a href="#Last-command">Last command</a></li>
<li><a href="#index-comint_002dstop_002dsubjob-114"><code>comint-stop-subjob</code></a>: <a href="#Other">Other</a></li>
<li><a href="#index-comment_002dcolumn-155"><code>comment-column</code></a>: <a href="#Indenting">Indenting</a></li>
<li><a href="#index-dump_0028_0029-131"><code>dump()</code></a>: <a href="#Edit-buffer">Edit buffer</a></li>
<li><a href="#index-ess_002dabort-113"><code>ess-abort</code></a>: <a href="#Other">Other</a></li>
<li><a href="#index-ess_002dask_002dabout_002ddisplay-203"><code>ess-ask-about-display</code></a>: <a href="#X11">X11</a></li>
<li><a href="#index-ess_002dask_002dabout_002dtransfile-68"><code>ess-ask-about-transfile</code></a>: <a href="#Saving-transcripts">Saving transcripts</a></li>
<li><a href="#index-ess_002dask_002dabout_002dtransfile-28"><code>ess-ask-about-transfile</code></a>: <a href="#Customizing-startup">Customizing startup</a></li>
<li><a href="#index-ess_002dask_002dfor_002dess_002ddirectory-26"><code>ess-ask-for-ess-directory</code></a>: <a href="#Customizing-startup">Customizing startup</a></li>
<li><a href="#index-ess_002dbeginning_002dof_002dfunction-160"><code>ess-beginning-of-function</code></a>: <a href="#Other-edit-buffer-commands">Other edit buffer commands</a></li>
<li><a href="#index-ess_002dchange_002dsp_002dregexp-50"><code>ess-change-sp-regexp</code></a>: <a href="#Completion-details">Completion details</a></li>
<li><a href="#index-ess_002dcleanup-193"><code>ess-cleanup</code></a>: <a href="#Help">Help</a></li>
<li><a href="#index-ess_002dcleanup-103"><code>ess-cleanup</code></a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-ess_002ddelete_002ddump_002dfiles-166"><code>ess-delete-dump-files</code></a>: <a href="#Source-Files">Source Files</a></li>
<li><a href="#index-ess_002ddescribe_002dhelp_002dmode-183"><code>ess-describe-help-mode</code></a>: <a href="#Help">Help</a></li>
<li><a href="#index-ess_002ddirectory-177"><code>ess-directory</code></a>: <a href="#Source-Directories">Source Directories</a></li>
<li><a href="#index-ess_002ddirectory-27"><code>ess-directory</code></a>: <a href="#Customizing-startup">Customizing startup</a></li>
<li><a href="#index-ess_002ddisplay_002dhelp_002don_002dobject-182"><code>ess-display-help-on-object</code></a>: <a href="#Help">Help</a></li>
<li><a href="#index-ess_002ddump_002dfilename_002dtemplate-173"><code>ess-dump-filename-template</code></a>: <a href="#Source-Directories">Source Directories</a></li>
<li><a href="#index-ess_002ddump_002dobject_002dinto_002dedit_002dbuffer-124"><code>ess-dump-object-into-edit-buffer</code></a>: <a href="#Edit-buffer">Edit buffer</a></li>
<li><a href="#index-ess_002ddump_002dobject_002dinto_002dedit_002dbuffer-117"><code>ess-dump-object-into-edit-buffer</code></a>: <a href="#Other">Other</a></li>
<li><a href="#index-ESS_002delsewhere-24"><code>ESS-elsewhere</code></a>: <a href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a></li>
<li><a href="#index-ess_002dend_002dof_002dfunction-161"><code>ess-end-of-function</code></a>: <a href="#Other-edit-buffer-commands">Other edit buffer commands</a></li>
<li><a href="#index-ess_002deval_002dbuffer-148"><code>ess-eval-buffer</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-ess_002deval_002dfunction-144"><code>ess-eval-function</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-ess_002deval_002dfunction_002dand_002dgo-145"><code>ess-eval-function-and-go</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-ess_002deval_002dline-142"><code>ess-eval-line</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-ess_002deval_002dline_002dand_002dgo-143"><code>ess-eval-line-and-go</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-ess_002deval_002dline_002dand_002dstep-189"><code>ess-eval-line-and-step</code></a>: <a href="#Help">Help</a></li>
<li><a href="#index-ess_002deval_002dline_002dand_002dstep-150"><code>ess-eval-line-and-step</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-ess_002deval_002dregion-190"><code>ess-eval-region</code></a>: <a href="#Help">Help</a></li>
<li><a href="#index-ess_002deval_002dregion-146"><code>ess-eval-region</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-ess_002deval_002dregion_002dand_002dgo-147"><code>ess-eval-region-and-go</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-ess_002deval_002dvisibly_002dp-137"><code>ess-eval-visibly-p</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-ess_002dexecute-92"><code>ess-execute</code></a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-ess_002dexecute_002dattach-95"><code>ess-execute-attach</code></a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-ess_002dexecute_002din_002dprocess_002dbuffer-83"><code>ess-execute-in-process-buffer</code></a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-ess_002dexecute_002din_002dtb-153"><code>ess-execute-in-tb</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-ess_002dexecute_002dobjects-84"><code>ess-execute-objects</code></a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-ess_002dexecute_002dsearch-88"><code>ess-execute-search</code></a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-ess_002dfancy_002dcomments-156"><code>ess-fancy-comments</code></a>: <a href="#Indenting">Indenting</a></li>
<li><a href="#index-ess_002dfunction_002dtemplate-128"><code>ess-function-template</code></a>: <a href="#Edit-buffer">Edit buffer</a></li>
<li><a href="#index-ess_002dkeep_002ddump_002dfiles-167"><code>ess-keep-dump-files</code></a>: <a href="#Source-Files">Source Files</a></li>
<li><a href="#index-ess_002dlist_002dobject_002dcompletions-46"><code>ess-list-object-completions</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-ess_002dload_002dfile-132"><code>ess-load-file</code></a>: <a href="#Loading">Loading</a></li>
<li><a href="#index-ess_002dload_002dfile-97"><code>ess-load-file</code></a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-ess_002dmode_002dfont_002dlock_002dkeywords-198"><code>ess-mode-font-lock-keywords</code></a>: <a href="#Highlighting">Highlighting</a></li>
<li><a href="#index-ess_002dparse_002derrors-136"><code>ess-parse-errors</code></a>: <a href="#Error-Checking">Error Checking</a></li>
<li><a href="#index-ess_002dparse_002derrors-98"><code>ess-parse-errors</code></a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-ess_002dquit-192"><code>ess-quit</code></a>: <a href="#Help">Help</a></li>
<li><a href="#index-ess_002dquit-115"><code>ess-quit</code></a>: <a href="#Other">Other</a></li>
<li><a href="#index-ess_002dremote-23"><code>ess-remote</code></a>: <a href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a></li>
<li><a href="#index-ess_002drequest_002da_002dprocess-21"><code>ess-request-a-process</code></a>: <a href="#Multiple-ESS-processes">Multiple ESS processes</a></li>
<li><a href="#index-ess_002dresynch-51"><code>ess-resynch</code></a>: <a href="#Completion-details">Completion details</a></li>
<li><a href="#index-ess_002dsearch_002dlist-180"><code>ess-search-list</code></a>: <a href="#Source-Directories">Source Directories</a></li>
<li><a href="#index-ess_002dskip_002dto_002dhelp_002dsection-188"><code>ess-skip-to-help-section</code></a>: <a href="#Help">Help</a></li>
<li><a href="#index-ess_002dskip_002dto_002dnext_002dsection-186"><code>ess-skip-to-next-section</code></a>: <a href="#Help">Help</a></li>
<li><a href="#index-ess_002dskip_002dto_002dprevious_002dsection-187"><code>ess-skip-to-previous-section</code></a>: <a href="#Help">Help</a></li>
<li><a href="#index-ess_002dsource_002ddirectory-175"><code>ess-source-directory</code></a>: <a href="#Source-Directories">Source Directories</a></li>
<li><a href="#index-ess_002dsubmit_002dbug_002dreport-207"><code>ess-submit-bug-report</code></a>: <a href="#Reporting-Bugs">Reporting Bugs</a></li>
<li><a href="#index-ess_002dswitch_002dto_002dend_002dof_002dESS-191"><code>ess-switch-to-end-of-ESS</code></a>: <a href="#Help">Help</a></li>
<li><a href="#index-ess_002dswitch_002dto_002dend_002dof_002dESS-163"><code>ess-switch-to-end-of-ESS</code></a>: <a href="#Other-edit-buffer-commands">Other edit buffer commands</a></li>
<li><a href="#index-ess_002dswitch_002dto_002dESS-164"><code>ess-switch-to-ESS</code></a>: <a href="#Other-edit-buffer-commands">Other edit buffer commands</a></li>
<li><a href="#index-ess_002dtrans_002dfont_002dlock_002dkeywords-199"><code>ess-trans-font-lock-keywords</code></a>: <a href="#Highlighting">Highlighting</a></li>
<li><a href="#index-ess_002dtranscript_002dclean_002dregion-71"><code>ess-transcript-clean-region</code></a>: <a href="#Saving-transcripts">Saving transcripts</a></li>
<li><a href="#index-ess_002dtranscript_002dcopy_002dcommand-121"><code>ess-transcript-copy-command</code></a>: <a href="#Resubmit">Resubmit</a></li>
<li><a href="#index-ess_002dtranscript_002dsend_002dcommand-120"><code>ess-transcript-send-command</code></a>: <a href="#Resubmit">Resubmit</a></li>
<li><a href="#index-ess_002dtranscript_002dsend_002dcommand_002dand_002dmove-66"><code>ess-transcript-send-command-and-move</code></a>: <a href="#Transcript-resubmit">Transcript resubmit</a></li>
<li><a href="#index-exit_0028_0029-102"><code>exit()</code></a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-inferior_002dess_002dfont_002dlock_002dkeywords-197"><code>inferior-ess-font-lock-keywords</code></a>: <a href="#Highlighting">Highlighting</a></li>
<li><a href="#index-inferior_002dess_002dprogram-30"><code>inferior-ess-program</code></a>: <a href="#Customizing-startup">Customizing startup</a></li>
<li><a href="#index-inferior_002dess_002dsend_002dinput-64"><code>inferior-ess-send-input</code></a>: <a href="#Transcript-resubmit">Transcript resubmit</a></li>
<li><a href="#index-inferior_002dess_002dsend_002dinput-36"><code>inferior-ess-send-input</code></a>: <a href="#Command_002dline-editing">Command-line editing</a></li>
<li><a href="#index-objects_0028_0029-85"><code>objects()</code></a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-printer_0028_0029-201"><code>printer()</code></a>: <a href="#printer">printer</a></li>
<li><a href="#index-q_0028_0029-101"><code>q()</code></a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-S-12"><code>S</code></a>: <a href="#Starting-up">Starting up</a></li>
<li><a href="#index-S_002belsewhere-25"><code>S+elsewhere</code></a>: <a href="#ESS-processes-on-Remote-Computers">ESS processes on Remote Computers</a></li>
<li><a href="#index-search_0028_0029-89"><code>search()</code></a>: <a href="#Hot-keys">Hot keys</a></li>
<li><a href="#index-search_0028_0029-44"><code>search()</code></a>: <a href="#Completion">Completion</a></li>
<li><a href="#index-source_0028_0029-138"><code>source()</code></a>: <a href="#Evaluating-code">Evaluating code</a></li>
<li><a href="#index-source_0028_0029-133"><code>source()</code></a>: <a href="#Loading">Loading</a></li>
<li><a href="#index-STERM-108"><code>STERM</code></a>: <a href="#Statistical-Process-running-in-ESS_003f">Statistical Process running in ESS?</a></li>
</ul>
<div class="contents">
<h2>Inhaltsverzeichnis</h2>
<ul>
<li><a name="toc_Top" href="#Top">ESS: Emacs Speaks Statistics</a>
<li><a name="toc_Introduction" href="#Introduction">1 Introduction to ESS</a>
<ul>
<li><a href="#Features">1.1 Why should I use ESS?</a>
<li><a href="#New-features">1.2 New features in ESS</a>
<li><a href="#Credits">1.3 Authors of and contributors to ESS</a>
<li><a href="#Latest-version">1.4 Getting the latest version of ESS</a>
<li><a href="#Manual">1.5 How to read this manual</a>
</li></ul>
<li><a name="toc_Installation" href="#Installation">2 Installing ESS on your system</a>
<ul>
<li><a href="#Unix-installation">2.1 Unix installation</a>
<li><a href="#Microsoft-Windows-installation">2.2 Microsoft Windows installation</a>
<li><a href="#Requirements">2.3 Requirements</a>
</li></ul>
<li><a name="toc_Interactive-ESS" href="#Interactive-ESS">3 Interacting with statistical programs</a>
<ul>
<li><a href="#Starting-up">3.1 Starting an ESS process</a>
<li><a href="#Multiple-ESS-processes">3.2 Running more than one ESS process</a>
<li><a href="#ESS-processes-on-Remote-Computers">3.3 ESS processes on Remote Computers</a>
<li><a href="#S_002belsewhere-and-ESS_002delsewhere">3.4 S+elsewhere and ESS-elsewhere</a>
<li><a href="#Customizing-startup">3.5 Changing the startup actions</a>
</li></ul>
<li><a name="toc_Entering-commands" href="#Entering-commands">4 Interacting with the ESS process</a>
<ul>
<li><a href="#Command_002dline-editing">4.1 Entering commands and fixing mistakes</a>
<li><a href="#Completion">4.2 Completion of object names</a>
<li><a href="#Completion-details">4.3 Completion details</a>
<li><a href="#Transcript">4.4 Manipulating the transcript</a>
<ul>
<li><a href="#Last-command">4.4.1 Manipulating the output from the last command</a>
<li><a href="#Process-buffer-motion">4.4.2 Viewing older commands</a>
<li><a href="#Transcript-resubmit">4.4.3 Re-submitting commands from the transcript</a>
<li><a href="#Saving-transcripts">4.4.4 Keeping a record of your S session</a>
</li></ul>
<li><a href="#Command-History">4.5 Command History</a>
<li><a href="#History-expansion">4.6 References to historical commands</a>
<li><a href="#Hot-keys">4.7 Hot keys for common commands</a>
<li><a href="#Statistical-Process-running-in-ESS_003f">4.8 Is the Statistical Process running under ESS?</a>
<li><a href="#Emacsclient">4.9 Using emacsclient</a>
<li><a href="#Other">4.10 Other commands provided by inferior-ESS</a>
</li></ul>
<li><a name="toc_Transcript-Mode" href="#Transcript-Mode">5 Manipulating saved transcript files</a>
<ul>
<li><a href="#Resubmit">5.1 Resubmitting commands from the transcript file</a>
<li><a href="#Clean">5.2 Cleaning transcript files</a>
</li></ul>
<li><a name="toc_ESS-for-the-S-family" href="#ESS-for-the-S-family">6 ESS for the S family</a>
<ul>
<li><a href="#ESS_0028S_0029_002d_002dEditing-files">6.1 ESS[S]–Editing files</a>
<li><a href="#iESS_0028S_0029_002d_002dInferior-ESS-processes">6.2 iESS[S]–Inferior ESS processes</a>
<li><a href="#ESS_002dhelp_002d_002dassistance-with-viewing-help">6.3 ESS-help–assistance with viewing help</a>
<li><a href="#Philosophies-for-using-ESS_0028S_0029">6.4 Philosophies for using ESS[S]</a>
<li><a href="#Scenarios-for-use-_0028possibilities_002d_002dbased-on-actual-usage_0029">6.5 Scenarios for use (possibilities–based on actual usage)</a>
<li><a href="#Customization-Examples-and-Solutions-to-Problems">6.6 Customization Examples and Solutions to Problems</a>
</li></ul>
<li><a name="toc_Editing" href="#Editing">7 Editing S functions</a>
<ul>
<li><a href="#Edit-buffer">7.1 Creating or modifying S objects</a>
<li><a href="#Loading">7.2 Loading source files into the ESS process</a>
<li><a href="#Error-Checking">7.3 Detecting errors in source files</a>
<li><a href="#Evaluating-code">7.4 Sending code to the ESS process</a>
<li><a href="#Indenting">7.5 Indenting and formatting S code</a>
<li><a href="#Other-edit-buffer-commands">7.6 Commands for motion, completion and more</a>
<li><a href="#Source-Files">7.7 Maintaining S source files</a>
<li><a href="#Source-Directories">7.8 Names and locations of dump files</a>
</li></ul>
<li><a name="toc_Editing-R-documentation-files" href="#Editing-R-documentation-files">8 Editing R documentation files</a>
<li><a name="toc_Help" href="#Help">9 Reading help files</a>
<li><a name="toc_ESS-for-SAS" href="#ESS-for-SAS">10 ESS for SAS</a>
<ul>
<li><a href="#ESS_0028SAS_0029_002d_002dDesign-philosophy">10.1 ESS[SAS]–Design philosophy</a>
<li><a href="#ESS_0028SAS_0029_002d_002dEditing-files">10.2 ESS[SAS]–Editing files</a>
<li><a href="#ESS_0028SAS_0029_002d_002dTAB-key">10.3 ESS[SAS]–TAB key</a>
<li><a href="#ESS_0028SAS_0029_002d_002dBatch-SAS-processes">10.4 ESS[SAS]–Batch SAS processes</a>
<li><a href="#ESS_0028SAS_0029_002d_002dFunction-keys-for-batch-processing">10.5 ESS[SAS]–Function keys for batch processing</a>
<li><a href="#iESS_0028SAS_0029_002d_002dInteractive-SAS-processes">10.6 iESS[SAS]–Interactive SAS processes</a>
<li><a href="#iESS_0028SAS_0029_002d_002dCommon-problems">10.7 iESS[SAS]–Common problems</a>
<li><a href="#ESS_0028SAS_0029_002d_002dGraphics">10.8 ESS[SAS]–Graphics</a>
<li><a href="#ESS_0028SAS_0029_002d_002dMS-Windows">10.9 ESS[SAS]–MS Windows</a>
</li></ul>
<li><a name="toc_ESS-for-BUGS" href="#ESS-for-BUGS">11 ESS for BUGS</a>
<ul>
<li><a href="#ESS_0028BUGS_0029_002d_002dModel-files">11.1 ESS[BUGS]–Model files</a>
<li><a href="#ESS_0028BUGS_0029_002d_002dCommand-files">11.2 ESS[BUGS]–Command files</a>
<li><a href="#ESS_0028BUGS_0029_002d_002dLog-files">11.3 ESS[BUGS]–Log files</a>
</li></ul>
<li><a name="toc_Miscellaneous" href="#Miscellaneous">12 Other features of ESS</a>
<ul>
<li><a href="#Highlighting">12.1 Syntactic highlighting of buffers</a>
<li><a href="#Graphics">12.2 Using graphics with ESS</a>
<ul>
<li><a href="#printer">12.2.1 Using ESS with the <code>printer()</code> driver</a>
<li><a href="#X11">12.2.2 Using ESS with windowing devices</a>
<li><a href="#winjava">12.2.3 Java Graphics Device</a>
</li></ul>
<li><a href="#Imenu">12.3 Imenu</a>
<li><a href="#Toolbar">12.4 Toolbar</a>
<li><a href="#TAGS">12.5 TAGS</a>
<li><a href="#Rdired">12.6 Rdired</a>
</li></ul>
<li><a name="toc_Mailing-lists_002fbug-reports" href="#Mailing-lists_002fbug-reports">13 Bugs and Bug Reporting, Mailing Lists</a>
<ul>
<li><a href="#Bugs">13.1 Bugs</a>
<li><a href="#Reporting-Bugs">13.2 Reporting Bugs</a>
<li><a href="#Mailing-Lists">13.3 Mailing Lists</a>
</li></ul>
<li><a name="toc_Customization" href="#Customization">Anhang A Customizing ESS</a>
<li><a name="toc_Key-Index" href="#Key-Index">Key (Character) Index</a>
<li><a name="toc_Concept-Index" href="#Concept-Index">Concept Index</a>
<li><a name="toc_Variable-and-command-index" href="#Variable-and-command-index">Variable and command index</a>
</li></ul>
</div>
<div class="footnote">
<hr>
<a name="texinfo-footnotes-in-document"></a><h4>Fußnoten</h4><p class="footnote"><small>[<a name="fn-1" href="#fnd-1">1</a>]</small>
require the files.el patch to revert-buffer for the Local Variables
updating problem</p>
<p class="footnote"><small>[<a name="fn-2" href="#fnd-2">2</a>]</small> The variable <code>ess-change-sp-regexp</code> is a regular
expression matching commands which change the search list. You will
need to modify this variable if you have defined custom commands (other
than <code>attach</code>, <code>detach</code>, <code>collection</code> or <code>library</code>)
which modify the search list.</p>
<p><hr></div>
</body></html>
|