As some readers might have known, I started a new package knitr last month, and this time I decided to try to use the power of social network like Google+ and Twitter (something I used to stay away from), and so far I’m pretty satisfied with my attempts. I call GitHub the “Facebook” of programmers, and it is also very powerful to connect programmers and users. There are a few features that I think R programmers may want to try (I use knitr as an example):

1. Browse R code online: I hate checking out a whole package to read its source code, and R-Forge is clumsy (following the steps of sourceforge) in this aspect; the code on GitHub is highlighted and easy to thumb through. Besides, you can browse each commit and see what was changed (the difference is highlighted).
2. Issues: instead of writing your own TODO list which is often forgotten, both your users and you can create issues, and you can make discussions there; when you have got a fix, you can write a commit message like “fixed #46” in GIT and the issue 46 will be automatically closed. This is super cool little feature to me. What is more, there will be a reference to the commit which fixed the issue, so you can come back in the future and see how the issue was fixed. Currently knitr has got 50 issues in total, with 24 of them from users.
3. Inline comments: you can discuss code directly along the lines; this is a super super cool feature. Ramnath started to contribute to the code theme feature recently after he forked my repository, and the original author (i.e. me) can go to the fork and check changes; each change can be commented, e.g. we had quite a few discussions in this commit. This feels like you can sit together with another programmer, and point to the code with a pen, saying “I like this and you may need to revise that, …”. In comparison, the traditional way of collaboration is usually through email — email patches back and forth, which is way less straightforward. When Ramnath and I feel the work is mature, he can simply send me a pull request, and all the changes can be merged back to my repository. The other example is I saw the blog post by Songpants the other day, and I suggested he move the work to GitHub so I can make suggestions closer to the R code, and now the code is happily sitting on GitHub (so are my comments).
4. Wiki: it makes it so easy to quickly set up a documentation page; I have not done it for knitr yet, but I did it for the formatR package. It looks better than R’s documentation, right? Again, other people can collaborate with you in editing the wiki pages. The other way to make your documentation better is to write vignettes in Sweave, which usually takes a lot of efforts (wrestling with LaTeX) unless you use LyX+knitr like me; I feel vignettes are easy to make, but this is another story.
5. Stay tuned with a package: you can watch a repository (use the button in the top-right) so that you can read the updates of a package in the dashboard; alternatively, you can follow a GitHub user like you follow people on Twitter.
6. GitHub pages: this is probably the coolest feature; you can use another branch (called gh-pages) in your GIT repository to build your website based on Jekyll. I made the website for knitr in this way, because I really want to make knitr a beautiful package, so everything has to be beautiful, then R documentation was ruled out. Of course, Hadley is a pioneer in documenting R packages with websites. In the future, I may want to develop a package based on knitr which turns R documentation into a website automatically (with examples parsed and evaluated, plots inserted), so you can host it on GitHub or somewhere else. This is only an idea at the moment, and feel free to contact me if you are interested.

I cannot say I’m already an efficient R programmer, but GitHub did make me much more efficient.

Related Posts

• knitr: Elegant, flexible and fast dynamic report generation with R

Currently this package is still a beta version, so I’m looking for feedback from early birds on:

1. is the PDF documentation confusing in any places? e.g. you have no idea on how to install the package because it was not mentioned in the manual;
2. does the website look ugly in your browser? (I know it does with IE under Windows) I used a font from Google Font API, and it does not seem to be consistent across different web browsers/OS’es;
3. what kind of difficulties did you have in switching from Sweave/pgfSweave/whatever-Sweave to knitr?
4. do you like the idea of putting R code/output in a shaded frame in LaTeX? is the default shading (rgb(.97, .97, .97)) too dark or too light? how about the highlighting theme?
5. have you ever tried to hack at Sweave? I’d love to listen to your stories;
6. what else do you expect from knitr?

Feel free to file a bug report in the Issues page if you find any problems or have any suggestions. I appreciate your efforts in making this knitr package even neater!

Related Posts

• How to Become an Efficient and Collaborative R Programmer
• Sweave and pgfSweave in LyX 2.0.x (experimental)
• A Special Graphics Device in R: the Null Device
• How to Start Using (pgf)Sweave in LyX in One Minute
• Font Families for the R PDF Device

## install.packages('fun')
library(fun)
if (.Platform$OS.type == "windows")
         x11() else x11(type = "Xlib")
mine_sweeper()

Mine Sweeper in R

library(fun)
gomoku()

Five in a row in R

You can take a look at the list of functions in this package by reading the HTML help page (go to help.start()), and I also need to mention the demos, e.g. see demo('TurtleGraphics') for a demo of Turtle graphics (how many people know the old Logo programming language?), and demo(package = 'fun') for a list of all demos in this package.

demo('RealTurtle', package = 'fun')

A turtle drawn in R

Although these topics are not new, they can still be good programming exercises.

We started writing this package more than two years ago, but it was almost forgotten later until a few days ago someone mentioned the game “Five in a row” in our web forum. This forum is almost the Chinese version of R-help, and it is not unusual for people to bring forward all kinds of funny ideas with R. If you are at useR! 2011 right now, you probably have heard from George Zhang about the Chinese R conferences these years, and this forum has been the sponsor and organizer ever since the first conference (which I initiated). However, please do not get a wrong impression that Chinese useRs are doing mine sweepers with R every day.

Feel free to share with us if you have more fun. The developers’ page is at: https://github.com/yihui/fun

P. S. This package may remind some people about the sudoku package (e.g. Joshua Wiley has noticed it), and some people may even remember this:

library(fortunes)
fortune('sudoku')

Related Posts

• formatR update (0.1-6)
• formatR update (0.1-5)
• Rd2roxygen: Convert Rd to roxygen documentation
• Happy New Year with R
• Flash Animations by saveSWF() in Package “animation”

About half a year ago, I wrote a post on the configuration of (pgf)Sweave and LyX, which was intended to save us some efforts in going through all the details during the configuration. Now many things have changed: LyX 2.0 has internal support for Sweave, and fortunately I have been in touch with the developers on this feature (thanks to Gregor); meanwhile, there have also been many changes in the pgfSweave package. In all, we have a number of new features which we should definitely make use of.

New Features

A list of new features as far as I can remember:

1. support for Sweave in LyX 2.0 is internal, so there is no need to modify the preferences file manually (the converters have been defined internally)
2. most importantly, Sweave becomes an independent module now in LyX, which means you can use it with arbitrary layouts!
3. we can see the messages during compilation in LyX 2.0 (View–>View Messages), which is really really helpful and I would strongly recommend you to turn on this option when compiling Sweave documents, because you will know which code chunk goes wrong in case of any errors (in the past, you only got an annoying error dialog box which told you almost nothing about the error)
4. pgfSweave is faster: it uses the GNU make utility to compile graphics, and you can use multi cores if you like; the compilation becomes 3 steps (pdflatex, make, then pdflatex); other nice features include: the R code is put in an environment Hinput now so you can customize it in LaTeX preamble; there will be no longer a huge gap between the R code and the output (fixed by Liang Qi)…
5. tikzDevice has better support for multi-byte characters (using UTF8)

I have been working on improving the Sweave module and adding a new pgfSweave module to LyX, and now I have basically finished what I planned to do. See the ticket #7555 for details. To sum up,

1. LaTeX will not complain about not being able to find Sweave.sty; I used several tricks to guarantee this — even in the worst case, LaTeX can still use the hard-coded Sweave style;
2. Spaces and dots in path names or filenames will no longer be a problem;
3. the pgfSweave module is also working now;
4. you can export the reformatted R code in a LyX document with the pgfSweave module;

I have also tried to document all the cool bells and whistles in two examples, sweave.lyx and pgfsweave.lyx. Or you can directly read the PDF documents, sweave.pdf.tar.xz and pgfsweave.pdf.

Try the (pgf)Sweave Module

It seems several people are interested in testing the two modules, and it is actually very easy under Linux. So far I have had no luck with Windows to build LyX from source (I tried once; it took me days to compile and ended up with errors).

1. check out the source code of LyX: svn co svn://svn.lyx.org/lyx/lyx-devel/trunk lyx-devel
2. (cd lyx-devel) apply my patch sweave-patch.diff to the svn source you checked out just now: patch -p0 -i /path/to/sweave-patch.diff
3. build LyX

   ./autogen.sh
   ./configure
   make
   sudo make install

Done.

Currently the patch is still waiting on LyX Trac. If you run into any problems before the developers begin to look at the patch, please let me know and we will try to make the two modules more stable and useful. But first of all, please remember to keep all your software packages up-to-date: R 2.13.0, pgfSweave 1.2.1 (run update.packages() in R as frequently as you can) and LaTeX package pgf 2.10 (very important for externalization).

For LyX 1.6.x Users

If you have been using Sweave since LyX 1.6.x and followed the approach in my previous blog post, and you happen to be a Linux user as well, I apologize for the inconvenience: you probably need to remove all the old configurations. One way is to rename ~/.lyx/:

mv ~/.lyx ~/.lyx16

Then reconfigure LyX. If you have important configurations in the preferences file and the layouts directory under ~/.lyx/, you need to remove all the Sweave-related configurations (including the converters and format definitions), and also delete all the literate-*.layout files under the layouts directory. Then reconfigure LyX.

For Windows Users

Compiling LyX from source under Windows was pain for me, so the above approach might not work well for Windows users. Anyway, manual configuration is not terribly hard, as long as you understand how a LyX module works.

First we need to define a new format for pgfSweave (Tools –> Preferences; do exactly as the below screenshot shows, and note the upper or lower cases):

Define the pgfSweave format

Then we tell LyX how it should deal with such a format by defining a converter (e.g. select pgfSweave from the left drop-down list and LaTeX (plain) from the right list, then click the Add button; depending on your output type, you may need several similar converters):

pgfSweave converters

Next we define a module to use the above format and converter, and an R script to do the real job of Sweaving. Download pgfsweave.module and lyx-pgfsweave.R. Go to your installation directory of LyX, put pgfsweave.module under Resources/layouts and lyx-pgfsweave.R under Resources/scripts. Reconfigure LyX (Tools –> Reconfigure) and you are done.

You can test with my example pgfsweave.lyx.

Related Posts

• How to Start Using (pgf)Sweave in LyX in One Minute
• Press Enter in LyX Sweave as You Wish
• A Special Graphics Device in R: the Null Device
• Font Families for the R PDF Device
• knitr: Elegant, flexible and fast dynamic report generation with R

Here is an example per request of a reader of my blog:

library(tikzDevice)
options(tikzMetricPackages = c("\\usepackage[utf8]{inputenc}",
    "\\usepackage[T1]{fontenc}", "\\usetikzlibrary{calc}",
    "\\usepackage{amssymb}"))
## I need the amssymb package because I use \mathcal and \mathbb
tikz("formula.tex", width = 4, height = 4, standAlone = TRUE,
    packages = c("\\usepackage{tikz}",
                 "\\usepackage[active,tightpage,psfixbb]{preview}",
                 "\\PreviewEnvironment{pgfpicture}",
                 "\\setlength\\PreviewBorder{0pt}",
                 "\\usepackage{amssymb}"))
par(mar = c(4, 4, 0.1, 0.1), mgp = c(2, 0.9, 0))
plot(1, type = "n", xlab = "$x_1$", ylab = "$x_2$")
text(1, c(0.8, 1, 1.2), c("$\\underbrace{1,2,\\cdots,10}_{10}$",
    "$\\mathbb{ABCDEFG}$", "$\\mathcal{HIJKLMN}$"), cex = 2.5)
dev.off()

tools::texi2dvi("formula.tex", pdf = TRUE)
system(paste(getOption("pdfviewer"), "formula.pdf"))

Related Posts

• Press Enter in LyX Sweave as You Wish
• Create Animations in PDF Documents Using R
• Sweave and pgfSweave in LyX 2.0.x (experimental)
• How to Start Using (pgf)Sweave in LyX in One Minute
• On the Gory Loops in R

You may use install.packages('rggobi') to install the new version of rggobi from CRAN.

Also note that if you are a user of the RGtk2 package, you don’t need a standalone installation of GTK+ either if you have already installed GGobi 2.1.9, because the path of GGobi will be written in the PATH variable of your system and RGtk2 can load the required dll’s from GGobi’s directory.

Random Posts

• Identify Data Points in Off-Screen R Graphics Devices
• Spring in Fall
• Demonstration of Confidence Intervals Using R (Animated)
• SyntaxHighlighter Brush for the R Language
• Quincunx (Galton box, Bean machine) in R

1. the inline comments will also be preserved in most cases (in earlier versions, only single lines of comments are preserved)
2. tidy.source() gained a new argument 'text' to accept a character vector as the source code
3. multi-byte characters are supported in the formatR() GUI now (sorry, this is not completely true in 0.1-6; it has been fixed in 0.1-7)

The first feature is a request from Cameron, which is actually from another request  of another user. I also feel this is a necessary feature even from the first version of this package, but dealing with inline comments is not as easy as the single lines of comments, and it can be dangerous. Please read the help page of the function tidy.source() for all the dark and dirty tricks for preserving R comments when formatting the R code. Here is a quick example:

> library(formatR)
> src = c("# a single line of comments is preserved",
+     "1+1", "if(TRUE){",
+     paste("x=1  ", "# comments begin with at least 2 spaces!"),
+     "}else{", "x=2;print('Oh no... ask the right bracket to go away!')}",
+     "1*3 # this comment will be dropped!")
>
> ## source code
> cat(src, sep = "\n")
# a single line of comments is preserved
1+1
if(TRUE){
x=1   # comments begin with at least 2 spaces!
}else{
x=2;print('Oh no... ask the right bracket to go away!')}
1*3 # this comment will be dropped!

We can reformat the code as:

> ## the formatted version
> tidy.source(text = src)
# a single line of comments is preserved
1 + 1
if (TRUE) {
    x = 1   # comments begin with at least 2 spaces!
} else {
    x = 2
    print("Oh no... ask the right bracket to go away!")
}
1 * 3

Related Posts

• formatR update (0.1-5)
• Package “animation”: Statistical Animations in R
• The fun Package: Use R for Fun!
• Rd2roxygen: Convert Rd to roxygen documentation
• formatR: farewell to ugly R code

file.path(R.home('doc'), 'html', 'R.css')

Simply replace this file with my version:

which looks like:

R HTML Help Theme

Of course you can design your own R.css if you know CSS.

Random Posts

• When Does Statistics Become Meaningless?
• A Slider to Control Two Plotting Windows
• Process of Minimization by Gradient Descent (2D)
• Some Interesting Packages in R: swfDevice, RGoogleTrends, FlashMXML, SVGAnnotation
• Listening is A Better Way to Improve Pronunciation

Set Fireworks in R 2011

The above animation comes from the demo('fireworks') in the R package animation 2.0-0. Thanks for the contribution of Weicheng Zhu.

Another demo I did not mention on this Christmas was demo('Xmas2'):

Xmas snowflakes in R

Thanks for the contribution of Jing Jiao.

There are a whole bunch of new features in the animation package v2.0-0 (this version is a milestone), but I will keep silent for the time being, since it is not published on CRAN yet.

Related Posts

• Happy New Year with R
• Merry Christmas Using R
• Animations for Spatial Patterns (simulation only!)
• formatR update (0.1-5)
• My Talk on Animations at useR! 2010 (NIST, Gaithersburg)

getOption('device')

In a non-interactive session, the default device is pdf(). This is why Sweave has to create a file named Rplots.pdf no matter if you want it or not when you run Sweave on an Rnw file which has code chunks creating plots. Such a behaviour is annoying to me — the PDF file is not only unnecessary, but also time-consuming (creating this PDF file is completely a waste of time). Is there a way to set a “null” device? (like the /dev/null for *nix users) The answer is yes, but not so obvious. I have not found the device below documented anywhere:

options(device = function(...) {
    .Call("R_GD_nullDevice", PACKAGE = "grDevices")
})

This device can speed up Sweave a lot when there are many plots to draw. Here is a comparison:

x = rnorm(1000)
system.time({
    .Call("R_GD_nullDevice", PACKAGE = "grDevices")
    replicate(500, plot(x, pch = 1:21))
    dev.off()
})
#   user  system elapsed
#   1.51    0.02    1.53
system.time({
    pdf(file.path(tempdir(), "Rplots.pdf"))
    replicate(500, plot(x, pch = 1:21))
    dev.off()
})
#   user  system elapsed
#  47.81    0.20   48.10

One thing I don’t understand in Sweave is that it evaluates the code chunk twice if its Sweave options contain fig=TRUE. I think this might be a waste of time as well, and this is why I like pgfSweave, which has both the mechanism of caching R objects (using cacheSweave) and a smart way to cache graphics (using pgf).

WARNING: this null device may not work with plots that contain (math) expressions! (take a look at demo(plotmath) in case you do not know what are expressions in R graphics)

Related Posts

• Font Families for the R PDF Device
• Sweave and pgfSweave in LyX 2.0.x (experimental)
• How to Start Using (pgf)Sweave in LyX in One Minute
• Press Enter in LyX Sweave as You Wish
• knitr: Elegant, flexible and fast dynamic report generation with R