formatR update (0.1-6)
[This article was first published on Statistics, R, Graphics and Fun » R Language, and kindly contributed to R-bloggers]. (You can report issue about the content on this page here)
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.
A new version of the formatR package is available on CRAN now (binary packages are still on the way). There are three major updates:
- the inline comments will also be preserved in most cases (in earlier versions, only single lines of comments are preserved)
tidy.source()gained a new argument'text'to accept a character vector as the source code- multi-byte characters are supported in the
formatR()GUI now
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
To leave a comment for the author, please follow the link and comment on their blog: Statistics, R, Graphics and Fun » R Language.
R-bloggers.com offers daily e-mail updates about R news and tutorials about learning R and many other topics. Click here if you're looking to post or find an R/data-science job.
Want to share your content on R-bloggers? click here if you have a blog, or here if you don't.