Type: | Package |
Title: | Write MS-Word documents from R |
Version: | 1.5 |
Date: | 2012-03-16 |
Author: | Christian Ritter |
Maintainer: | Christian Ritter <R2wd@ridaco.be> |
Description: | This package uses either the statconnDCOM server (via the rcom package) or the RDCOMClient to communicate with MS-Word via the COM interface. |
Depends: | R (≥ 2.10.0) |
Suggests: | rcom, RDCOMClient |
SystemRequirements: | Windows |
License: | GPL-2 |
OS_type: | windows |
LazyLoad: | yes |
Packaged: | 2012-03-16 07:58:37 UTC; Chris |
Repository: | CRAN |
Date/Publication: | 2012-03-16 17:14:55 |
NeedsCompilation: | no |
Write MS-Word documents from R.
Description
R2wd uses a COM client to communicate with MS-Word via the COM interface (Windows only). Two COM clients are supported: "rcom" (Statconn DCOM via Rscproxy) and RDCOMClient (from the omegahat distribution). R2wd can be seen as a collection of convenience wrappers to calls of the COM client.
Details
Package: | R2wd |
Type: | Package |
Version: | 1.5.0 |
Date: | 2012-02-28 |
License: | GPL-2 |
LazyLoad: | yes |
If Word is not already running, wdGet() opens a new Word document, otherwise, it establishes a COM handle to the instance which is already running. If the parameter "filename" is specified, wdGet will check whether this file is already open or (if not) try to open it. The functions wdTitle, wdHeader, wdType, wdBody, and wdParagraph can be used to inject text elements into Word. Moreover, bookmarks can be added via wdInsertBookmarks and wdGoToBookmark allows to navigate among the bookmarks which also exist. There is another set of convenience functions, wdSection, wdSubsection, and wdSubsubsection which insert headers of level 1, 2, or 3, start new 'Sections' in Word, and add bookmarks.
Graphs and dataframes can be inserted into Word, by the wdPlot, wdTable commands. The wdTable command takes a dataframe or an array as arguments, creates a Word table of the appropriate dimensions and injects the content of the dataframe or array into it. It then formats the table in Word using elementary formating elements.
There are a few convenience functions for carrying out various typical functions in Word, such as undo, page setup, verbatim, etc.
The functions wdApplyTheme and wdApplyTemplate allow to work with themes and templates.
Author(s)
Christian Ritter
Maintainer: Christian Ritter <R2wd@ridaco.be>
Examples
## Not run:
## rcom needs to be installed
if (!require(rcom)) warning("Install rcom first")
## This initializes the hook to Word
## if Word is already running it connects to it via StatconnDcom
## if not, it uses StatconnDcom to open word to create a new document
## and to connect to it.
wdGet()
## Then there is a set of small functions which implement elementary
## functionality:
wdTitle("R2wd, A Package for writing Word Documents from R",label="R2wd")
##
wdSection("Introduction")
##
wdBody("This is an example on how to use the R2wd package.")
wdWrite("wdWrite continues writing in the same style. If you set paragraph to FALSE, it doesn't add a paragraph return at the end. For example, you can use to add a footnote",paragraph=FALSE)
wdInsertFootnote("Footnotes have two arguments, the footnote text and the footnote reference. By default, word creates the reference automatically, but you can also choose what you want.","whatUwant")
wdBody(". As it is shown here")
##
## We can also plot data. The following line uses the default plot command
##
wdPlot(1:100,sin((1:100)/10),type="l",main="a test graph")
##
## The plot command can be exchanged for something else
##
wdPlot(mtcars,plotfun=pairs,main="a test graph",height=6,width=6,pointsize=8)
##
## we can also do something more elaborate (requires latticeExtra)
##
if (!require(latticeExtra)) warning("Install latticeExtra first")
fun<-function(...) print(useOuterStrips(xyplot(...)))
wdPlot(mpg~hp|cyl+carb,data=mtcars,plotfun=fun,height=6,width=6)
##
## There is also rudimentary way to transfer data frames.
##
wdTable(mtcars)
##
## It may be useful to format them first
##
wdTable(format(mtcars))
##
## Finally, we can apply themes and templates
##
wdApplyTheme("Quad 100")
wdApplyTheme("BlueCalm 100")
wdApplyTheme("None")
wdSave("MyDoc")
##
wdQuit()
##
## Another example on how to wrap the definition of a plot into a function and call it from wdPlot
##
xseries = ts(1:100) #make the series of the wind stress
yseries = ts(1:100) #time series objects
myplot<-function(x,y){
par(mfrow=c(3,3), mar=c(2.5,4,4,1),oma=c(2,0,0,0)) #set up plot area
for (h in 0:8) { #loop through lags 0-8
plot.ts(xy.lines=F,xy.labels=F,lag(x,-h),y,main=paste("x(t-",h,")",sep=""),
ylab=expression(x[t]),xlab="")
mtext("Yearly",SOUTH<-1, line=0.0,adj=0, cex=1, col="Black", outer=TRUE)
}
}
wdPlot(x,y,plotfun=myplot,height=6,width=6,pointsize=9,bookmark="myplot",paragraph=TRUE)
##
## End(Not run)
Apply a word template.
Description
Apply a Word template.
Usage
wdApplyTemplate(filename, wdapp = .R2wd)
Arguments
filename |
The name of the template. |
wdapp |
The handle to the Word application (see details). |
Details
This function applies the given Word template. Indicating the handle to
the Word application is usually not necessary (will be tacitely
initialized by the wdGet
function and assigned to the session
variable .R2wd.
Note
This function is just a sketch on what could be done. Someone should write a few interesting templates to mirror typical LaTEX ones, such as article, report, etc.
Author(s)
Christian Ritter
Apply a word template.
Description
Apply a word template.
Usage
wdApplyTheme(theme, wdapp = .R2wd)
Arguments
theme |
The name of the theme. |
wdapp |
The handle to the Word application (see details). |
Details
This function applies the given Word template. Indicating the handle to
the Word application is usually not necessary (will be tacitely
initialized by the wdGet
function and assigned to the session
variable .R2wd.
Note
This function is just a sketch on what could be done.
Author(s)
Christian Ritter
Examples
## Not run:
## apply a default theme with a blue background.
wdApplyTheme("BlueCalm 100")
## remove the current theme
wdApplyTheme("None")
## End(Not run)
Write in body text.
Description
Inserts text in 'Body' style at the current cursor point in Word.
Usage
wdBody(text = "", paragraph = TRUE, wdapp = .R2wd)
Arguments
text |
a test string to be written to Word. |
paragraph |
whether a paragraph (line return) should be added at the end. |
wdapp |
the handle to word (can be ignored). |
Details
Switches to 'Body' style, adds the text, and then gives a carriage return (paragraph break) if requested.
Author(s)
Christian Ritter
Examples
## Not run: wdBody("R2wd is a package to write MS-Word files from R")
Unit conversion (inches, points, cm)
Description
This function converts between inches, cm, and points.
Usage
wdConvert(input,from="in",to="pt")
Arguments
input |
the number to convert |
from |
either "in","cm", or "pt". |
to |
either "in","cm", or "pt". |
Details
Converts the input value from from
units to to
units.
Value
the converted number.
Author(s)
Christian Ritter
Examples
## Not run:
wdConvert(1,"in","pt")
wdConvert(72,"pt","in")
wdConvert(1,"cm","pt")
## the following gives an error:
wdConvert(1,"cm","mm")
## End(Not run)
Start a numbered list
Description
This corresponds to pushing the [123] button in Word.
Usage
wdEnumerate(Gallery=2, Template=1, wdapp = .R2wd)
Arguments
Gallery |
the (numbered) item in the list gallery. The pre-set |
Template |
the (numbered) item in the list template. The pre-set |
wdapp |
the handle to word (can be ignored). |
Details
Starts a numbered list like pushing on the [123] button in Word.
Author(s)
Christian Ritter
Examples
## Not run: wdEnumerate("R2wd is a package to write MS-Word files from R")
Write formulas in Word
Description
This function allows writing formulas/equations into Word using the default formula editor in Word 2007 and 2010.
Usage
wdEqn(eqtext, bookmark = NULL, iknow=FALSE,waitsec=2,wdapp = .R2wd, paragraph = TRUE)
Arguments
eqtext |
a text string containing the formula |
bookmark |
a text string containing the bookmark to use (otherwise default) |
iknow |
acknowledgement of danger using sendkeys |
waitsec |
time R waits while sendkey sends the equation |
wdapp |
the handle to the Word application |
paragraph |
whether to insert a paragraph after the equation |
Details
This function uses two tools to write a formula to Word. At first it
uses the COM client to write a text into the range property of the
selection and converts it to a formula. Then it uses the sendkeys method
of the wsshell to add a carriage return. This causes Word to parse the
formula and to substitute LaTeX like tokens such as \alpha
by their
corresponding formula equivalents (the greek letter alpha). In
principle, it should be possible to achieve the parsing of the formula
by invoking the BuildUp method of the omaths(1) object, but this does
not work in the current versions of Word. The route via Sendkeys is
fragile, so handle with caution.
Value
none
Examples
## Not run:
wdGet()
wdTitle("Try a formula")
## note that double \ has to be used instead of \
## note that the , the following lines
## must be pasted into the console and run there.
## running them from an Emacs/ESS buffer won't work
wdEqn("\\alpha \\over ( \\beta +3 ) ")
wdEqn("\\alpha \\over (( \\beta +3 ))")
wdEqn("\\matrix(\\alpha &0@0&1 ) ")
## note: the handling of parentheses "(" is a bit peculiar in Word
## also experiment with the handling of empty spaces
## End(Not run)
Gets a handle to Word (using RDCOMClient).
Description
wdGet checks first if Word is already running. If this is not the case, it will start Word, add a document and then return the handle to the Word application. If Word is already running and has an active document, it will just return the handle.
Usage
wdGet(filename = NULL, path = "", method="rcom",visible = TRUE)
Arguments
filename |
the filename of an existing word document (if null, make a new one) |
path |
the path to an existing word document |
method |
the COM client. Either "rcom" (default) or "RDCOMClient" |
visible |
whether the Word application should be visible. |
Value
a handle to the COM object refering to the Word application.
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdTitle("R2wd, a package to write Word documents from R")
## End(Not run)
Get a property from Word.
Description
This function descends down a property tree given in the parameter
vector property
and returns the lowest level.
Usage
wdGetProperty(property,object = wdapp[["Selection"]], wdapp = .R2wd)
Arguments
property |
The name of a property or a vector indicating a path in a property tree. |
object |
The object on which the property tree should start. |
wdapp |
The handle to Word. |
Details
This function descends down the indicated property tree and returns the
lowest level. It can also work with calls to the 'Items' method. In this
case, the corresponding item numbers should be inserted in the
property
vector.
Value
The value of the lowest level of the property tree.
Author(s)
Christian Ritter
See Also
Examples
## Not run:
wdGet()
wdTitle("Title",paragraph=FALSE)
wdGetProperty(c("Font","Name"))
wdGetProperty(c("Font","Size"))
wdParagraph()
wdWrite("This is in normal font")
wdGetProperty(c("Font","Name"))
wdGetProperty(c("Font","Size"))
## End(Not run)
Navigate to a bookmark in the active Word document.
Description
Looks up the bookmark
in the bookmarks collection and goes to it.
Usage
wdGoToBookmark(bookmark, wdapp = .R2wd)
Arguments
bookmark |
the name of the bookmark. |
wdapp |
the handle to the Word application (usually not needed). |
Examples
## Not run:
wdGet()
## the following command starts a new section and adds a bookmark.
wdSection("This a new section",label="sec1")
## now we add some text
wdBody("R2wd is a package to write Word documents from R")
## we can now go back to the section header
wdGoToBookmark("sec1")
## End(Not run)
Add text in Heading style.
Description
Add text in Heading style.
Usage
wdHeading(level = 1, text = "", paragraph = TRUE, wdapp = .R2wd)
Arguments
level |
The heading level. |
text |
The text to write as a heading. |
paragraph |
Whether a paragraph should start after the heading. |
wdapp |
The handle to the Word Application (usually not needed). |
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdHeading(1,"R2wd")
wdHeading(2,"General ",paragraph=FALSE)
wdHeading(2,"Principles")
## End(Not run)
Insert a Bookmark.
Description
Inserts a Bookmark at the current selection.
Usage
wdInsertBookmark(text, wdapp = .R2wd)
Arguments
text |
the bookmark text. |
wdapp |
the handle to the Word Application (usually not needed). |
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdTitle("R2wd a package for writing Word documents from R")
wdInsertBookmark("here")
wdBody("This package allows ...")
wdSection("General")
wdGoToBookmark("here")
## End(Not run)
Insert a Footnote
Description
Inserts a footnote at the current selection.
Usage
wdInsertFootnote(text="",reference="",wdapp=.R2wd)
Arguments
text |
the footnote text. |
reference |
the footnote reference. By default, this is generated automatically by Word. |
wdapp |
the handle to the Word Application (usually not needed). |
Value
(invisible): a handle to the footnote object. Can be used to manipulate (usually not used).
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdTitle("R2wd a package for writing Word documents from R")
wdInsertFootnote("see also SWORD (rcom.unive.ac.at) for integrating R
calculations in word documents.")
wdBody("This package allows ...")
## End(Not run)
Start a bullet list
Description
This corresponds to pushing the [123] button in Word.
Usage
wdItemize(Gallery=1, Template=1, wdapp = .R2wd)
Arguments
Gallery |
the (numbered) item in the list gallery. The pre-set |
Template |
the (numbered) item in the list template. The pre-set |
wdapp |
the handle to word (can be ignored). |
Details
Starts a bullet list like pushing on the [123] button in Word.
Author(s)
Christian Ritter
Examples
## Not run: wdItemize("R2wd is a package to write MS-Word files from R")
Start a new document (when Word is running).
Description
This adds a new document to a running Word Application. If a name is given, the new document is saved under the given name.
Usage
wdNewDoc(name = NULL, wdapp = .R2wd)
Arguments
name |
the optional name of the file. |
wdapp |
the handle to word (usually not needed) |
Author(s)
Christian Ritter
See Also
Examples
## Not run:
wdGet()
wdNewDoc("This.doc")
wdQuit()
## End(Not run)
Type text in Normal style.
Description
Type text in 'Normal' style and end with a paragraph break if requested.
Usage
wdNormal(text = "", paragraph = TRUE, wdapp = .R2wd)
Arguments
text |
the text to write. |
paragraph |
whether a paragraph break should be added at the end. |
wdapp |
the handle to the Word Application (usually not needed). |
Note
This is almost the same as wdBody
.
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdTitle("R2wd: A package to write ...")
wdNormal("R2wd is a package for ...")
## End(Not run)
Insert a page break.
Description
Insert a page break.
Usage
wdPageBreak(wdapp = .R2wd)
Arguments
wdapp |
the handle to Word Application (usually not needed). |
Examples
## Not run:
wdGet()
wdTitle("R2wd: Writing Word Documents from R")
wdBody("R2wd permits writing ...")
wdPageBreak(continuous=FALSE)
wdBody("It goes on on the next page")
## End(Not run)
Modify page setup in Word.
Description
Modify page setup in Word.
Usage
wdPageSetup(orientation = "portrait", margins = rep(1, 4), scope = "section", wdapp = .R2wd)
Arguments
orientation |
page orientation, either "portrait" or "landscape" |
margins |
a vector of page margins in inches (a unit variable will be supplied later) |
scope |
whether the change applies to the entire document ("all") or only to the present section ("section"). |
wdapp |
handle to the Word Application (usually not needed). |
Details
this invokes the required methods in word to set page orientation and margins
Examples
## Not run:
wdGet()
wdPageSetup(orientation="landscape",margins=c(2,2,2,2),scope="all")
## End(Not run)
Insert a paragraph break.
Description
Insert a paragraph break.
Usage
wdParagraph(wdapp = .R2wd)
Arguments
wdapp |
the handle to Word Application (usually not needed). |
create an R plot and paste it into word.
Description
By default, this uses the plot
function to create the plot
according to the arguments given as ...
. The plot
function
can be replaced by another function which creates a graph.
Usage
wdPlot(..., plotfun = plot, caption="",method="metafile",height = 5, width = 5,
pointsize = 10, bookmark = NULL, wdapp = .R2wd, paragraph = TRUE)
Arguments
... |
the arguments to the plot function |
plotfun |
the plot function (by default |
caption |
figure caption |
method |
the graphics device type ( |
height |
the height of the plot in R units (commonly inches) |
width |
the width of the plot in R units (commonly inches) |
pointsize |
the pointsize of the plot |
bookmark |
the bookmark text (if missing, a default will be created) |
wdapp |
the handle to the Word Application (usually not needed) |
paragraph |
whether a paragraph is given after inserting the plot. |
Details
The plot is transfered as a windows metafile.
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
## a basic call using the default metafile device
wdTitle("R2wd: plotting")
wdPlot(1:100,sin(1:100),type="l",bty="l")
## a call using a ggplot function which uses semi-transparency
## this requires the bitmap device (the metafile device is nicer but doesn't render semi-transparency)
require(ggplot2)
funny<-function(){
c <- ggplot(mtcars, aes(qsec, wt))
print(c + stat_smooth())
}
wdPlot(plotfun=funny,method="bitmap")
## End(Not run)
Close Word and remove the handle.
Description
Close Word and remove the handle.
Usage
wdQuit(wdapp = .R2wd)
Arguments
wdapp |
the handle to the Word Application. |
Details
This closes Word. Word may ask back whether you wish to save the graph.
Examples
## Not run:
wdGet()
wdQuit()
## End(Not run)
Save the active document.
Description
Save the active document. If a name is given, it is used for the new document, otherwise Word will ask.
Usage
wdSave(Name = NULL, wdapp = .R2wd)
Arguments
Name |
File name (if missing, Word will ask). |
wdapp |
The handle to the Word Application (usually not needed). |
Details
Saves the active document to the name if given or Word will ask for a name.
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdSave("This File.doc")
wdQuit()
## End(Not run)
Start a new section of the document.
Description
Start a section by: Adding a section break, switching to Heading1 style, adding the section title, adding a bookmark, adding a paragraph break, switching to Normal style.
Usage
wdSection(title, label = gsub("[.,-:?!@#+* ]", "_", paste("sec", title, sep = "_")),
newpage = FALSE, wdapp = .R2wd)
Arguments
title |
section title |
label |
bookmark text (will be generated automatically if missing) |
newpage |
whether the section should start on a new page (doesn't work) |
wdapp |
handle to Word Application (usually not needed). |
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdTitle("R2wd a package to ... ")
wdSection("Introduction",newpage=TRUE)
## End(Not run)
Insert a section break.
Description
Insert a section break. Depending on the setting of continuous
start a new page for this.
Usage
wdSectionBreak( continuous = TRUE, bookmark = NULL,wdapp = .R2wd)
Arguments
continuous |
if FALSE, the Word section will start on a new page |
bookmark |
bookmark text |
wdapp |
handle to Word application (usually not needed) |
Author(s)
Christian Ritter
Get handle to current Selection in Word Application.
Description
Get handle to current Selection in Word Application.
Usage
wdSelection(wdapp = .R2wd)
Arguments
wdapp |
handle to Word Application (usually not needed) |
Author(s)
Christian Ritter
Set font in Word.
Description
This function allows to set the font type and the font size of the active Word document.
Usage
wdSetFont(fontname = NULL, fontsize = NULL, bold=NULL, italic=NULL,wdapp = .R2wd)
Arguments
fontname |
A font name Word knows about, such as Arial, Times New Roman, etc. |
fontsize |
The point size of the font. |
bold |
The point size of the font. |
italic |
The point size of the font. |
wdapp |
The handle to Word. |
Details
This function uses the handle .R2wd to talk to Word and to change font name and size at the current position of the cursor in the active document.
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdTitle("Title")
wdWrite("This is in normal font")
wdSetFont(fontname="Garamond",fontsize=14,bold=TRUE,italic=TRUE)
wdWrite("This is in 14pt Garamond")
wdNormal("This switches back to Normal")
## End(Not run)
Set a property in Word.
Description
This function descends down a property tree given in the parameter
vector property
and sets the lowest level to value
.
Usage
wdSetProperty(property, value, object = wdapp[["Selection"]], wdapp = .R2wd)
Arguments
property |
The name of a property or a vector indicating a path in a property tree. |
value |
The value, the lowest level in the property tree should be set to. |
object |
The object on which the property tree should start. |
wdapp |
The handle to Word. |
Details
This function descends down the indicated property tree. It can also
work with calls to the 'Items' method. In this case, the corresponding
item numbers should be inserted in the property
vector.
Author(s)
Christian Ritter
See Also
Examples
## Not run:
wdGet()
wdTitle("Title")
wdWrite("This is in normal font")
wdSetProperty(c("Font","Name"),"Garamond")
wdSetProperty(c("Font","Size"),20)
wdWrite("This is in 14pt Garamond")
wdNormal("This switches back to Normal")
## End(Not run)
Modify document style
Description
Modify document style
Usage
wdStyleSetup(style = "Normal", fontsize = 11, align=3, wdapp = .R2wd)
Arguments
style |
default: "Normal" |
fontsize |
default 11pt |
align |
type of alignment: 3 corresponds to "justified" |
wdapp |
handle to the Word Application (usually not needed). |
Details
this invokes the required methods in word to set the document style
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdStyleSetup()
## End(Not run)
Start a new Word section, add a heading and a bookmark.
Description
Start a subsection (see wdSection
for details.
Usage
wdSubsection(title, label = gsub("[.,-:?!@#+* ]", "_", paste("subsec", title, sep = "_")),
newpage = FALSE, wdapp = .R2wd)
Arguments
title |
the sub section title. |
label |
the bookmark. |
newpage |
whether the section should start on a new page. |
wdapp |
the handle to the Word Application (usually not needed). |
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdTitle("Title")
wdSection("Section 1",newpage=TRUE)
wdSubsection("Sub-section 1.1")
wdSubsubsection("Sub-sub-section 1.1.a")
## End(Not run)
Start a new Word section, add a heading and a bookmark.
Description
Start a subsection (see wdSection
for details.
Usage
wdSubsubsection(title, label = gsub("[.,-:?!@#+* ]", "_",
paste("subsec", title, sep = "_")),
newpage = FALSE, wdapp = .R2wd)
Arguments
title |
the sub-sub-section title. |
label |
the bookmark. |
newpage |
whether the section should start on a new page. |
wdapp |
the handle to the Word Application (usually not needed). |
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdTitle("Title")
wdSection("Section 1",newpage=TRUE)
wdSubsection("Sub-section 1.1")
wdSubsubsection("Sub-sub-section 1.1.a")
## End(Not run)
Write a dataframe or an array as a Word table.
Description
Make a Word table to the adequate dimensions, fill it, format it, and add a bookmark (and a caption - doesn't work yet).
Usage
wdTable(data, caption = "", caption.pos="below",bookmark = NULL, pointsize = 9, padding = 5, autoformat = 1, row.names=TRUE,align = if (row.names) c("l",rep("r", ncol(data))) else c(rep("r", ncol(data))),hlines=NULL,wdapp = .R2wd)
Arguments
data |
a data frame or an array |
caption |
the caption to use in Word |
caption.pos |
the caption position "below" or "above" |
bookmark |
the bookmark to use in Word |
pointsize |
the pointsize in Word |
padding |
how much cell-padding (in points) |
autoformat |
which of the Word autoformats to use (try 1, 2, 3) |
row.names |
whether row names should be printed (default=TRUE) |
align |
alignment instruction. Default: c("l",rep("r",ncol(data))): align first column left and the others right. "c" stands for centering. The character "|" can be inserted where the user wishes a vertical line to be drawn. |
hlines |
a character vector of length nrow(data)+1 containing "b","t","bt",or "n" to indicate whether a horizontal line should be drawn below, on top, or both. "n" means none. |
wdapp |
the handle to the Word Application (usually not needed). |
Details
Creates a Word table to the adequate dimensions and inserts it between two paragraph breaks. Fills it with dataframe or array (using the clipboard). Creates a bookmark and adds a caption. Uses word autoformating and aligns columns according to user input.
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdTitle("The example mtcars")
wdTable(format(mtcars))
## End(Not run)
Add text in title style.
Description
Add text in title style and add a paragraph bread if needed.
Usage
wdTitle(title,
label = substring(gsub("[, .]", "_", paste("text", title, sep = "_")), 1, 16),
paragraph = TRUE, wdapp = .R2wd)
Arguments
title |
the text to format in title style |
label |
the bookmark text (if given) |
paragraph |
whether a paragraph break should be added at the end. |
wdapp |
the handle to the Word Application (usually not needed). |
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdTitle("Title")
wdSection("Section 1",newpage=TRUE)
wdSubsection("Sub-section 1.1")
wdSubsubsection("Sub-sub-section 1.1.a")
## End(Not run)
write text to word
Description
Inserts text at the current cursor point in Word (by default without messing with styles).
Usage
wdType(text = "", italic=FALSE, alignment="nothing", paragraph = TRUE, wdapp = .R2wd)
Arguments
text |
a test string to be written to Word. |
italic |
if |
alignment |
choice of "nothing", "left", "center", "right". |
paragraph |
whether a paragraph (line return) should be added at the end. |
wdapp |
the handle to word (can be ignored). |
Details
Switches to 'Type' style, adds the text, and then gives a carriage return (paragraph break) if requested.
Author(s)
Christian Ritter
Examples
## Not run: wdType("R2wd is a package to write MS-Word files from R")
Save the active document.
Description
Save the active document. If a name is given, it is used for the new document, otherwise Word will ask.
Usage
wdUndo(times = 1, wdapp = .R2wd)
Arguments
times |
the |
wdapp |
The handle to the Word Application (usually not needed). |
Details
Saves the active document to the name if given or Word will ask for a name.
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdTitle("By default, writing a title represents 5 calls to word: Style, type text,
inserting a bookmark, typing a paragraph, and setting the style back to normal")
# we can undo it by invoking the Undo method on the document five times
wdUndo(5)
wdQuit()
## End(Not run)
write verbatim text to word (for example model output).
Description
write single spaced text in (by default) Courier font to word. This is useful to render R output 'as is'.
Usage
wdVerbatim(text = "", paragraph = TRUE, fontsize = 9, fontname = "Courier New", wdapp = .R2wd)
Arguments
text |
the text to write |
paragraph |
whether the chunk should be closed by a paragraph return. |
fontsize |
size of the font |
fontname |
name of the font |
wdapp |
handle to the Word application (usually not used). |
Details
Saves the current style. Wwitches to Courier New, single spaced, 9 pt (by default) and renders the text. Switches back to the previous style.
Note
This is almost the similar to wdBody
and wdWrite
.
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
tt<-capture.output(summary(lm(mpg~hp,data=mtcars)))
wdVerbatim(tt)
## End(Not run)
Write text to word.
Description
Write text in current style and end with a paragraph break if requested.
Usage
wdWrite(text = "", paragraph = FALSE, wdapp = .R2wd)
Arguments
text |
the text to write. |
paragraph |
whether a paragraph break should be added at the end. |
wdapp |
the handle to the Word Application (usually not needed). |
Note
This is almost the same as wdBody
.
Author(s)
Christian Ritter
Examples
## Not run:
wdGet()
wdTitle("R2wd: A package to write ...")
wdSetFont(fontname="Symbol")
wdWrite("R2wd is a package for ...")
## End(Not run)