This file is indexed.

/usr/share/lyx/examples/sweave.lyx is in lyx-common 2.1.4-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

   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
#LyX 2.1 created this file. For more info see http://www.lyx.org/
\lyxformat 474
\begin_document
\begin_header
\textclass article
\begin_preamble
%% maxwidth is the original width if it's less than linewidth
%% otherwise use linewidth (to make sure the graphics do not exceed the margin)
\def\maxwidth{%
\ifdim\Gin@nat@width>\linewidth
\linewidth
\else
\Gin@nat@width
\fi
}
\end_preamble
\options nogin
\use_default_options true
\begin_modules
sweave
\end_modules
\maintain_unincluded_children false
\language english
\language_package auto
\inputencoding default
\fontencoding global
\font_roman palatino
\font_sans lmss
\font_typewriter lmtt
\font_math auto
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100
\font_tt_scale 100
\graphics default
\default_output_format default
\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize default
\spacing single
\use_hyperref false
\papersize default
\use_geometry true
\use_package amsmath 1
\use_package amssymb 1
\use_package cancel 0
\use_package esint 1
\use_package mathdots 1
\use_package mathtools 0
\use_package mhchem 1
\use_package stackrel 0
\use_package stmaryrd 0
\use_package undertilde 0
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
\justification true
\use_refstyle 0
\index Index
\shortcut idx
\color #008000
\end_index
\leftmargin 3cm
\topmargin 3cm
\rightmargin 3cm
\bottommargin 3cm
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
\quotes_language english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\end_header

\begin_body

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout

%
\backslash
SweaveOpts{prefix=TRUE,prefix.string=sweave-prefix,keep.source=FALSE}
\end_layout

\end_inset


\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout

%% 
\backslash
maxwidth was defined in the preamble; see document settings
\end_layout

\begin_layout Plain Layout


\backslash
setkeys{Gin}{width=
\backslash
maxwidth}
\end_layout

\end_inset


\end_layout

\begin_layout Title
Using Sweave with LyX
\end_layout

\begin_layout Author
Yihui Xie
\begin_inset Foot
status collapsed

\begin_layout Plain Layout
Department of Statistics, Iowa State University.
 Email: 
\begin_inset CommandInset href
LatexCommand href
name "xie@yihui.name"
target "xie@yihui.name"
type "mailto:"

\end_inset


\end_layout

\end_inset

 
\begin_inset ERT
status collapsed

\begin_layout Plain Layout


\backslash
and
\end_layout

\end_inset

 Gregor Gorjanc 
\begin_inset ERT
status collapsed

\begin_layout Plain Layout


\backslash
and
\end_layout

\end_inset

 Jean-Marc Lasgouttes
\end_layout

\begin_layout Standard
Sweave is a tool in the R language (
\begin_inset Flex URL
status collapsed

\begin_layout Plain Layout

http://www.r-project.org
\end_layout

\end_inset

) for dynamic report generation using the ideas of literate programming.
 R code can be mixed into a LaTeX document, and will be executed in R when
 the document is compiled; the results are written into the TeX output.
\end_layout

\begin_layout Standard
Since LyX 2.0, Sweave can be used out of the box with any document class
 using the 
\family sans
Sweave
\family default
 module.
 We can add the 
\family sans
Sweave
\family default
 module to a LyX document from 
\family sans
Document\SpecialChar \menuseparator
Settings\SpecialChar \menuseparator
Modules
\family default
.
 In this manual, we demonstrate some common features of Sweave and explain
 how the module works.
 A PDF version of this manual can be found at 
\begin_inset Flex URL
status collapsed

\begin_layout Plain Layout

https://github.com/downloads/yihui/lyx/sweave.pdf
\end_layout

\end_inset

.
\end_layout

\begin_layout Section
System Requirements
\end_layout

\begin_layout Standard
The 
\family sans
Sweave
\family default
 module depends on the executable 
\family typewriter
Rscript
\family default
, so it has to be in the 
\family sans
PATH
\family default
 variable of the system.
 It is usually not a problem for Linux and Mac OS users, but may be confusing
 to Windows users; if you do not understand what is 
\family sans
PATH
\family default
 under Windows, you may either use the R script 
\family sans
add-R-path-win.R
\family default
 in the repository 
\begin_inset Flex URL
status collapsed

\begin_layout Plain Layout

https://github.com/yihui/lyx
\end_layout

\end_inset

 to change it automatically (not recommended; you should learn 
\family sans
PATH
\family default
 anyway), or go to 
\family sans
Tools\SpecialChar \menuseparator
Preferences\SpecialChar \menuseparator
Paths\SpecialChar \menuseparator
PATH prefix
\family default
 to add the bin path of R (recommended), which is often like 
\family sans
C:
\backslash
Program Files
\backslash
R
\backslash
R-x.x.x
\backslash
bin
\family default
 and you can find it in R:
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout

<<where-is-R-bin,eval=FALSE>>=
\end_layout

\begin_layout Plain Layout

R.home('bin')
\end_layout

\begin_layout Plain Layout

@
\end_layout

\end_inset


\end_layout

\begin_layout Standard
After you have done these changes, you need to reconfigure LyX by 
\family sans
Tools\SpecialChar \menuseparator
Reconfigure
\family default
.
 If 
\family typewriter
Rscript
\family default
 is not present in 
\family sans
PATH
\family default
, the 
\family sans
Sweave
\family default
 module will be unavailable.
 It is recommended to use the latest version of R, since Sweave is still
 being updated.
 Another dependency is introduced by the LaTeX style file 
\family sans
Sweave.sty
\family default
 which is shipped with R under this path (it is not on CTAN):
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout

<<sweave-sty,eval=FALSE>>=
\end_layout

\begin_layout Plain Layout

file.path(R.home('share'), 'texmf', 'tex', 'latex')
\end_layout

\begin_layout Plain Layout

@
\end_layout

\end_inset


\end_layout

\begin_layout Standard
MikTeX users may add the texmf directory to the list of root directories
 in MikTeX through MikTeX settings.
 Further note that 
\family sans
Sweave.sty
\family default
 depends on the 
\series bold
fancyvrb
\series default
 package and 
\emph on
may
\emph default
 depend on 
\series bold
ae
\series default
.
 If LyX cannot find 
\family sans
Sweave.sty
\family default
, it will directly copy from R, so the Sweave module works even if you do
 not know where is this style file.
\end_layout

\begin_layout Section
Sweave Examples
\end_layout

\begin_layout Standard
Before we write an Sweave document, we can set some Sweave options; the
 command is 
\family typewriter

\backslash
SweaveOpts{}
\family default
 in Sweave and it can be inserted in a LyX document by 
\family sans
Insert\SpecialChar \menuseparator
Custom Insets\SpecialChar \menuseparator
Sweave Options
\family default
, or just use TeX code to write it (
\family sans
Insert\SpecialChar \menuseparator
TeX Code
\family default
).
 For example, we can set a global option 
\family typewriter
echo=FALSE
\family default
 in the beginning of a document to suppress all R code (by default, both
 R code and its output will show up in the LaTeX document).
 
\end_layout

\begin_layout Standard
To write R code in LyX, you can first switch to the 
\family typewriter
Chunk
\family default
 environment in the layout styles list (droplist in the top-left corner
 in the toolbar), or you can simply open a TeX code environment and write
 Sweave code chunks in it.
 The latter approach is recommended since it is more stable.
\end_layout

\begin_layout Standard
Some R options can be useful to the Sweave output as well, e.g.
 
\family typewriter
width
\family default
 and 
\family typewriter
useFancyQuotes
\family default
.
 The former option can adjust the width of the output, and the latter can
 avoid a common problem with quotes.
 Users are encouraged to read the Sweave manual in R for more details.
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout

<<setup, keep.source=TRUE>>=
\end_layout

\begin_layout Plain Layout

## the option 'digits' can set the (approximate) number of digits
\end_layout

\begin_layout Plain Layout

options(width = 70, useFancyQuotes = FALSE, digits = 4)
\end_layout

\begin_layout Plain Layout

@
\end_layout

\begin_layout Plain Layout

<<sweave-manual, eval=FALSE, keep.source=TRUE>>=
\end_layout

\begin_layout Plain Layout

## view the Sweave vignette (requires R >= 2.13.0)
\end_layout

\begin_layout Plain Layout

vignette("Sweave", package = "utils")
\end_layout

\begin_layout Plain Layout

@
\end_layout

\end_inset


\end_layout

\begin_layout Standard
A simple example that will run in any S engine: 
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout

<<print-integers, keep.source=TRUE>>=
\end_layout

\begin_layout Plain Layout

## the integers from 1 to 10 are
\end_layout

\begin_layout Plain Layout

1:10 
\end_layout

\begin_layout Plain Layout

@
\end_layout

\begin_layout Plain Layout

<<hide-results, results=hide>>=
\end_layout

\begin_layout Plain Layout

## intentionally hide the output by setting results=hide
\end_layout

\begin_layout Plain Layout

print(1:20)
\end_layout

\begin_layout Plain Layout

@
\end_layout

\end_inset


\end_layout

\begin_layout Standard
We can also emulate a simple calculator: 
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout

<<calculator>>=
\end_layout

\begin_layout Plain Layout

1 + pi
\end_layout

\begin_layout Plain Layout

sin(pi/6)
\end_layout

\begin_layout Plain Layout

@
\end_layout

\end_inset


\end_layout

\begin_layout Standard
Now we look at some Gaussian data:
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout

<<rnorm>>=
\end_layout

\begin_layout Plain Layout

set.seed(123)  # for reproducibility
\end_layout

\begin_layout Plain Layout

x <- rnorm(20)
\end_layout

\begin_layout Plain Layout

print(x)
\end_layout

\begin_layout Plain Layout

t1 <- t.test(x)
\end_layout

\begin_layout Plain Layout

@
\end_layout

\end_inset


\end_layout

\begin_layout Standard
Note that we can easily integrate some numbers into standard text; this
 is done with the command 
\family typewriter

\backslash
Sexpr{}
\family default
, and the corresponding LyX menu is 
\family sans
Insert\SpecialChar \menuseparator
Custom Insets\SpecialChar \menuseparator
S/R expression
\family default
, or alternatively just use TeX code.
 For example, the third element of the vector 
\family typewriter
x
\family default
 is 
\begin_inset Flex S/R expression
status collapsed

\begin_layout Plain Layout

x[3]
\end_layout

\end_inset

 (i.e.
 
\family typewriter
x[3]
\family default
) and the 
\begin_inset Formula $p$
\end_inset

-value of the test is 
\begin_inset Flex S/R expression
status collapsed

\begin_layout Plain Layout

format.pval(t1$p.value)
\end_layout

\end_inset

.
 You can round these numbers using functions like 
\emph on
round()
\emph default
 in R.
 
\end_layout

\begin_layout Standard

\family roman
\series medium
\shape up
\size normal
\emph off
\bar no
\noun off
\color none
Now we look at a summary of the 
\family typewriter
\series default
\shape default
\size default
\emph default
\bar default
\noun default
\color inherit
iris
\family roman
\series medium
\shape up
\size normal
\emph off
\bar no
\noun off
\color none
 dataset:
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout

<<iris-summary>>=
\end_layout

\begin_layout Plain Layout

summary(iris[,-5])
\end_layout

\begin_layout Plain Layout

@
\end_layout

\end_inset


\end_layout

\begin_layout Standard
\begin_inset Float table
wide false
sideways false
status open

\begin_layout Plain Layout
\begin_inset Caption Standard

\begin_layout Plain Layout
Quantiles of the first four variables in the 
\family typewriter
iris
\family default
 data.
\begin_inset CommandInset label
LatexCommand label
name "tab:xtable-demo"

\end_inset


\end_layout

\end_inset


\end_layout

\begin_layout Plain Layout
\align center
\begin_inset ERT
status open

\begin_layout Plain Layout

\end_layout

\begin_layout Plain Layout

<<xtable-demo,results=tex,echo=FALSE>>=
\end_layout

\begin_layout Plain Layout

if (require('xtable')) {
\end_layout

\begin_layout Plain Layout

print(xtable(sapply(iris[,-5], quantile)), floating=FALSE)
\end_layout

\begin_layout Plain Layout

} else cat('the xtable package is not available! please install.packages("xtable"
)')
\end_layout

\begin_layout Plain Layout

@
\end_layout

\end_inset


\end_layout

\end_inset


\end_layout

\begin_layout Standard
Usually people do not like such 
\begin_inset Quotes eld
\end_inset

raw
\begin_inset Quotes erd
\end_inset

 output, and we can polish these messy numbers with the 
\series bold
xtable
\series default
 package.
 Table 
\begin_inset CommandInset ref
LatexCommand ref
reference "tab:xtable-demo"

\end_inset

 is an example demonstrating how to use the 
\series bold
xtable
\series default
 package with Sweave; note the chunk option 
\family typewriter
results=tex
\family default
 makes sure that the R output is written out as raw LaTeX code instead of
 being wrapped in a special environment (
\family typewriter
Soutput
\family default
).
\end_layout

\begin_layout Standard
Figure 
\begin_inset CommandInset ref
LatexCommand ref
reference "fig:iris-pairs"

\end_inset

 and 
\begin_inset CommandInset ref
LatexCommand ref
reference "fig:iris-boxplots"

\end_inset

 are two simple examples of producing graphics output with Sweave.
\end_layout

\begin_layout Standard
\begin_inset Float figure
wide false
sideways false
status open

\begin_layout Plain Layout
\align center
\begin_inset Note Note
status open

\begin_layout Plain Layout
Both eps and pdf are set to true so that both latex and pdflatex work.
 In practice, you would probably just choose one.
\end_layout

\end_inset


\begin_inset ERT
status open

\begin_layout Plain Layout

<<iris-pairs,fig=TRUE,width=4.5,height=4.5,eps=TRUE,pdf=TRUE>>=
\end_layout

\begin_layout Plain Layout

pairs(iris, col = iris$Species)
\end_layout

\begin_layout Plain Layout

@
\end_layout

\end_inset


\end_layout

\begin_layout Plain Layout
\begin_inset Caption Standard

\begin_layout Plain Layout
Scatter plot matrix of the 
\family typewriter
iris
\family default
 data.
\begin_inset CommandInset label
LatexCommand label
name "fig:iris-pairs"

\end_inset


\end_layout

\end_inset


\end_layout

\end_inset


\end_layout

\begin_layout Standard
\begin_inset Float figure
wide false
sideways false
status open

\begin_layout Plain Layout
\align center
\begin_inset ERT
status open

\begin_layout Plain Layout

<<iris-boxplots,fig=TRUE,width=7,height=2,keep.source=F,eps=T,pdf=T>>=
\end_layout

\begin_layout Plain Layout

par(mar=c(4,5,.1,.3), las=1)
\end_layout

\begin_layout Plain Layout

boxplot(Sepal.Length~Species,data=iris,horizontal=TRUE,xlab='Sepal.Length')
\end_layout

\begin_layout Plain Layout

@
\end_layout

\end_inset


\end_layout

\begin_layout Plain Layout
\begin_inset Caption Standard

\begin_layout Plain Layout
Boxplots of sepal length grouped by species.
\begin_inset CommandInset label
LatexCommand label
name "fig:iris-boxplots"

\end_inset


\end_layout

\end_inset


\end_layout

\end_inset


\end_layout

\begin_layout Standard
We can also export all the R code in an Sweave document as a single R script
 (
\family sans
File\SpecialChar \menuseparator
Export\SpecialChar \menuseparator
R/S code
\family default
), which is done via 
\family typewriter
R CMD Stangle
\family default
.
\end_layout

\begin_layout Section
The 
\family sans
Sweave
\family default
 Module
\end_layout

\begin_layout Standard
The 
\family sans
Sweave
\family default
 module declares that a LyX document contains literate programming components
 with R, so that LyX will handle such documents according to the specific
 converters (see the Customization manual).
 The 
\family sans
Sweave
\family default
 module uses the 
\family sans
sweave
\family default
 converter, which essentially consists of an R script 
\family sans
lyxsweave.R
\family default
 under the 
\family sans
scripts
\family default
 directory of LyX.
 This script takes an 
\family sans
Rnw
\family default
 document from LyX and call Sweave to process it to a TeX document, then
 LyX takes care of the rest of work.
\end_layout

\begin_layout Standard
The converter from the 
\family sans
sweave
\family default
 format to LaTeX is a call to R via the command line as:
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout


\backslash
begin{verbatim}
\end_layout

\begin_layout Plain Layout

Rscript --no-save --no-restore $$s/scripts/lyxsweave.R $$p$$i $$p$$o $$e
 $$r
\end_layout

\begin_layout Plain Layout


\backslash
end{verbatim}
\end_layout

\end_inset


\end_layout

\begin_layout Standard
The LyX library directory 
\family typewriter
$$s
\family default
 can be found from the menu 
\family sans
Help\SpecialChar \menuseparator
About LyX
\family default
.
 All the rest of options passed to R are explained in the R script, and
 the LyX Customization manual also has detailed explanations about 
\family typewriter
$$i
\family default
, 
\family typewriter
$$o
\family default
, 
\family typewriter
$$e
\family default
 and 
\family typewriter
$$r
\family default
.
 General users do not need to know clearly what they mean, but here we need
 to explain a few issues in the R code:
\end_layout

\begin_layout Enumerate
the encoding string of the LyX document is passed to R as an command line
 option; possible values are 
\family typewriter
ISO-8859-15
\family default
 and 
\family typewriter
UTF-8
\family default
, etc.
 The encoding is used for R to read the 
\family sans
Rnw
\family default
 document correctly.
\end_layout

\begin_layout Enumerate
the R code chunks in the Sweave document are executed under the directory
 of the LyX document (if you are not sure, put 
\family typewriter
getwd()
\family default
 in a code chunk to see what is the current working directory).
 In this case, you can put data files under the same directory and use relative
 paths in R to guarantee reproducibility, i.e.
 we do not need to write hard-coded paths which may not exist in other systems.
\end_layout

\begin_layout Enumerate
if LaTeX cannot find 
\family sans
Sweave.sty
\family default
, this R script will copy it to the temporary directory automatically where
 the LaTeX compilation takes place.
\end_layout

\begin_layout Enumerate
Sweave will use the filename of the Rnw file as the prefix string for the
 graphics output by default; one known issue (
\begin_inset CommandInset href
LatexCommand href
name "#7551"
target "http://www.lyx.org/trac/ticket/7551"

\end_inset

) is that if the filename (without extension) contains dots, LaTeX can fail
 to deal with such files in 
\family typewriter

\backslash
includegraphics{}
\family default
.
 Therefore, we have set the default value of the prefix to be the filename
 with all the dots being replaced by 
\begin_inset Quotes eld
\end_inset

-
\begin_inset Quotes erd
\end_inset

.
 We can also solve this problem in Sweave directly: set the Sweave option
 
\family typewriter
prefix.string
\family default
 to be a character string without dots, and this option will override the
 default value.
\end_layout

\begin_layout Standard
We have pre-specified an option 
\family typewriter
noae
\family default
 for the Sweave package.
 This option stops Sweave from loading these two packages:
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout


\backslash
begin{verbatim}
\end_layout

\begin_layout Plain Layout


\backslash
RequirePackage[T1]{fontenc}  
\end_layout

\begin_layout Plain Layout


\backslash
RequirePackage{ae}
\end_layout

\begin_layout Plain Layout


\backslash
end{verbatim}
\end_layout

\end_inset


\end_layout

\begin_layout Standard
LyX can deal with the font encoding by default, so there is no need to ask
 Sweave to do this (furthermore, this may bring clashes of package options);
 besides, the users can load the 
\series bold
ae
\series default
 package by themselves in the preamble if needed.
\end_layout

\begin_layout Section
Trouble Shooting
\end_layout

\begin_layout Standard
Since LyX 2.0, we can see the detailed information during compilation via
 
\family sans
View\SpecialChar \menuseparator
View Messages
\family default
.
 This is extremely helpful for trouble shooting -- the process of R will
 be shown in the message panel, and we will be able to know which chunk
 goes wrong in cases of errors.
 For example, when you compile this document, you can see messages like
 below:
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout


\backslash
begin{verbatim}
\end_layout

\begin_layout Plain Layout

17:58:47.868: Processing code chunks with options ...
\end_layout

\begin_layout Plain Layout

17:58:47.885:  1 : echo keep.source term verbatim (label=setup)
\end_layout

\begin_layout Plain Layout

17:58:47.889:  2 : echo keep.source (label=sweave-manual)
\end_layout

\begin_layout Plain Layout

17:58:47.908:  3 : echo keep.source term verbatim (label=print-integers)
\end_layout

\begin_layout Plain Layout

....
\end_layout

\begin_layout Plain Layout

17:58:47.941: Loading required package: xtable
\end_layout

\begin_layout Plain Layout

17:58:47.976:  9 : echo term verbatim pdf (label=iris-pairs)
\end_layout

\begin_layout Plain Layout

....
\end_layout

\begin_layout Plain Layout

17:58:48.116: You can now run (pdf)latex on 'sweave.tex'
\end_layout

\begin_layout Plain Layout


\backslash
end{verbatim}
\end_layout

\end_inset


\end_layout

\begin_layout Standard
The string after 
\family typewriter
label=
\family default
 is the chunk label.
 If any chunk causes an error in R, you will see the error message here
 immediately.
\end_layout

\begin_layout Standard
Another known issue is the Sweave code chunk may fail when we change the
 alignment of the chunk paragraph in LyX (using 
\family sans
Paragraph settings
\family default
), because LyX may add a macro like 
\family typewriter

\backslash
centering{}
\family default
 before the code chunk without adding a new line, which will lead to a code
 chunk like this:
\end_layout

\begin_layout Standard
\begin_inset ERT
status open

\begin_layout Plain Layout


\backslash
begin{verbatim}
\end_layout

\begin_layout Plain Layout


\backslash
centering{}<<xtable-demo,results=tex,echo=FALSE>>=
\end_layout

\begin_layout Plain Layout


\backslash
end{verbatim}
\end_layout

\end_inset


\end_layout

\begin_layout Standard
This is not a legitimate Sweave code chunk, since 
\family typewriter
<<>>=
\family default
 must start in a new line with nothing before it.
 Therefore we recommend you to double check the real source code via 
\family sans
View\SpecialChar \menuseparator
View Source
\family default
 when changing the alignment of a chunk paragraph, and make sure 
\family typewriter
<<>>=
\family default
 appears in a new line.
 This explains why we manually added an empty line in the code chunk in
 Table 
\begin_inset CommandInset ref
LatexCommand ref
reference "tab:xtable-demo"

\end_inset

.
\end_layout

\begin_layout Section
Resources
\end_layout

\begin_layout Standard
The homepage of Sweave is at 
\begin_inset Flex URL
status collapsed

\begin_layout Plain Layout

http://www.stat.uni-muenchen.de/~leisch/Sweave/
\end_layout

\end_inset

.
 The CRAN task view on 
\begin_inset Quotes eld
\end_inset

Reproducible Research
\begin_inset Quotes erd
\end_inset

 has a list of Sweave-related packages which can be potentially useful;
 see 
\begin_inset Flex URL
status collapsed

\begin_layout Plain Layout

http://cran.r-project.org/web/views/ReproducibleResearch.html
\end_layout

\end_inset

.
 Questions about LyX and Sweave can be posted to the LyX mailing list (
\begin_inset Flex URL
status collapsed

\begin_layout Plain Layout

http://www.lyx.org/MailingLists
\end_layout

\end_inset

).
 More LyX examples are provided at 
\begin_inset Flex URL
status collapsed

\begin_layout Plain Layout

https://github.com/yihui/lyx
\end_layout

\end_inset

.
\end_layout

\begin_layout Section
FAQ
\end_layout

\begin_layout Subsection
How to use Sweave with beamer?
\end_layout

\begin_layout Standard
You will end up with LaTeX errors if you use Sweave in normal beamer slides
 in LyX; the reason is the beamer frame that contains verbatim R code.
 The solution is to use a 
\emph on
FragileFrame
\emph default
 instead of a normal 
\emph on
Frame
\emph default
, or to pass the option 
\family typewriter
fragile
\family default
 to the frame title via 
\family sans
Insert\SpecialChar \menuseparator
Frame Options
\family default
.
\end_layout

\begin_layout Subsection
Can I define my own R script to compile the Rnw document?
\end_layout

\begin_layout Standard
Yes, of course.
 First you need to understand how the R script 
\family typewriter
$$s
\family sans
/scripts/lyxsweave.R
\family default
 works, which was introduced previously, and we recommend you to read the
 R source code as well (on how R takes the paths and uses 
\emph on
Sweave()
\emph default
 to handle the Rnw document).
 Then you put your customized 
\family sans
lyxsweave.R
\family default
 under the 
\family sans
scripts
\family default
 directory of your 
\emph on
user directory
\emph default
 (again, see 
\family sans
Help\SpecialChar \menuseparator
About LyX
\family default
).
 Note LyX will check the 
\emph on
user directory
\emph default
 before going to its own 
\emph on
library directory
\emph default
; if an R script 
\family sans
lyxsweave.R
\family default
 is found in the user directory, it will be used.
 It is not recommended to hack the script under the LyX library directory
 directly, since updating LyX will override you modified script (the user
 directory will not be affected).
\end_layout

\begin_layout Standard
Beside the support for the official Sweave in R, the 
\series bold
knitr
\series default
 package is also supported, which is an alternative tool to Sweave; the
 corresponding module is named 
\family sans
Rnw (knitr)
\family default
.
\end_layout

\end_body
\end_document