Package `vimcom`

Package ‘vimcom’
February 15, 2013
Version 0.9-7
Date 2013-01-31
Title Intermediate the communication between Vim and R
Author Jakson Aquino
Maintainer Jakson Alves de Aquino <[email protected]>
Suggests knitr
Description Provide a service to intermediate the communication between Vim and R.
License GPL (>= 2)
URL https://github.com/jalvesaq/VimCom
Repository CRAN
Date/Publication 2013-01-31 15:32:31
NeedsCompilation yes
R topics documented:
vimcom-package . .
etags2ctags . . . . .
vim.bol . . . . . . .
vim.help . . . . . . .
vim.interlace.rmd . .
vim.interlace.rnoweb
vim.interlace.rrst . .
vim.list.args . . . . .
vim.names . . . . . .
vim.openpdf . . . . .
vim.plot . . . . . . .
vim.print . . . . . . .
vim.srcdir . . . . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
Index
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
2
2
3
3
4
5
5
6
6
6
7
7
7
8
1
2
etags2ctags
vimcom-package
Allow the communication between Vim and R
Description
This package provides a TCP/IP server to allow the communication between R and Vim-R-plugin.
It also has some functions called by the plugin. By default, the elements of data.frames are shown
in the object browser, but not the elements of other types of lists, and, by default, names of objects
which begin with a dot are omitted. The following options control the vimcom behavior:
Option
vimcom.verbose
vimcom.opendf
vimcom.openlist
vimcom.allnames
Description
Print information.
Show data.frames elements.
Show lists elements.
Show .GlobalEnv hidden objects.
Default
0
TRUE
FALSE
FALSE
You may want to put the options above in your Rprofile rather than setting them and loading the
vimcom package manually. Below is an example of ~/.Rprofile
if(interactive()){
options(vimcom.verbose = 1)
options(vimcom.allnames = TRUE)
library(vimcom)
}
Author(s)
Jakson Alves de Aquino <[email protected]>
See Also
Startup
etags2ctags
Convert an Emacs tags file into the CTags file format.
Description
Convert an Emacs tags file into the CTags file format.
Usage
etags2ctags(etagsfile, ctagsfile)
vim.bol
3
Arguments
etagsfile
Path to Emacs tags file.
ctagsfile
Path to the CTags file to be created.
Author(s)
Jakson Alves de Aquino <[email protected]>
vim.bol
Build omnilist for Vim.
Description
Build the omnils file for Vim. The function is supposed to be called by the user through Vim-Rplugin (command :RUpdateObjList).
Usage
vim.bol(omnilist, packlist, allnames = FALSE)
Arguments
omnilist
Path to the omnilist file.
packlist
Character vector listing the packages whose list of objects should be built.
allnames
Logical. Whether to include objects whose names start with a dot.
Author(s)
Jakson Alves de Aquino <[email protected]>
vim.help
Write R help content into a file to be read by Vim
Description
This function is supposed to be called by the Vim-R-plugin.
Usage
vim.help(topic, w, classfor, package)
4
vim.interlace.rmd
Arguments
topic
The topic whose help is desired.
w
The width of the text.
classfor
The R expression following a parenthesis. This expression will be used to call
the help for a function method (if available) instead of the default documentation
help.
package
The package where the function is.
Author(s)
Jakson Alves de Aquino <[email protected]>
vim.interlace.rmd
Convert a rmd file to PDF
Description
Run the knitr function knit() to convert a rmd file to PDF.
Usage
vim.interlace.rmd(Rmdfile, view = TRUE, pdfquiet = FALSE,
pandoc_args = "", pdfout = "latex", ...)
Arguments
Rmdfile
The path to the Rmd file.
view
Logical value indicating whether to show the generated PDF document.
pdfquiet
Whether to suppress output of application opening the PDF.
pandoc_args
Arguments to pandoc.
pdfout
Type of output.
...
Further arguments to be passed to knit().
vim.interlace.rnoweb
5
vim.interlace.rnoweb
Run either Sweave or knit and, then, pdflatex on a Rnoweb file
Description
Run the R function Sweave() or knit() and, then, the application pdflatex.
Usage
vim.interlace.rnoweb(rnowebfile, latexcmd = "pdflatex", bibtex = FALSE,
knit = FALSE, view = TRUE, quiet = TRUE,
pdfquiet = FALSE, ...)
Arguments
rnowebfile
The path to the Rnoweb file.
latexcmd
The command to run on the generated .tex file.
bibtex
Whether to run bibtex.
knit
Whether to use knitr instead of Sweave.
view
Logical value indicating whether to show the generated PDF document.
quiet
Whether to pass quiet = TRUE to texi2pdf (Windows only).
pdfquiet
Whether to suppress output of application opening the PDF.
...
Further arguments to be passed to Sweave.
vim.interlace.rrst
Run knit2pdf to convert a Rrst file to to PDF using pdflatex or rst2pdf
Description
Run the knitr function knit2pdf() to convert a Rrst (reStructuredText) file to PDF. If desired, the
user can specify to use ‘rst2pdf’ to compile to PDF if a LaTeX installation is not present.
Usage
vim.interlace.rrst(Rrstfile, view = TRUE, pdfquiet = FALSE, ...)
Arguments
Rrstfile
The path to the Rrst file.
view
Logical value indicating whether to show the generated PDF document.
pdfquiet
Whether to suppress output of application opening the PDF.
...
Further arguments to be passed to compiler (usually rst2pdf or pdflatex).
6
vim.openpdf
List function arguments
vim.list.args
Description
List function arguments and the function methods arguments.
Usage
vim.list.args(ff)
Arguments
ff
vim.names
A function.
List function arguments
Description
List the names of either the object elements or its slots.
Usage
vim.names(x)
Arguments
x
vim.openpdf
An R object.
Run the pdf file in external application
Description
Open the pdf file in external application.
Usage
vim.openpdf(x, quiet = FALSE)
Arguments
x
The file name.
quiet
Whether to suppress output of application opening the PDF.
vim.plot
7
Plot an object
vim.plot
Description
Plot an object. If the object is numeric, plot histogram and boxplot instead of default scatter plot.
Usage
vim.plot(x)
Arguments
x
The object.
Print an object.
vim.print
Description
Print an object. If the object is a function, search for a method for the classfor expression. The
function is supposed to be called by the Vim-R-plugin.
Usage
vim.print(object, classfor)
Arguments
object
classfor
An R object.
The R expression following the parenthesis, if any.
vim.srcdir
Source all .R file of a given directory.
Description
Source all .R file of a given directory.
Usage
vim.srcdir(dr = ".")
Arguments
dr
The directory path.
Index
∗Topic package
vimcom-package, 2
etags2ctags, 2
Startup, 2
texi2pdf, 5
vim.bol, 3
vim.help, 3
vim.interlace.rmd, 4
vim.interlace.rnoweb, 5
vim.interlace.rrst, 5
vim.list.args, 6
vim.names, 6
vim.openpdf, 6
vim.plot, 7
vim.print, 7
vim.srcdir, 7
vimcom (vimcom-package), 2
vimcom-package, 2
8