ToWrd | R Documentation |
Send objects like tables, ftables, lm tables, TOnes or just simple texts to a MS-Word document.
ToWrd(x, font = NULL, ..., wrd = DescToolsOptions("lastWord"))
## S3 method for class 'Freq'
ToWrd(x, font = NULL, main = NULL, ..., wrd = DescToolsOptions("lastWord"))
## S3 method for class 'table'
ToWrd(x, font = NULL, main = NULL, align = NULL,
tablestyle = NULL, autofit = TRUE,
row.names = TRUE, col.names = TRUE, ..., wrd = DescToolsOptions("lastWord"))
## S3 method for class 'data.frame'
ToWrd(x, font = NULL, main = NULL, row.names = NULL, ...,
wrd = DescToolsOptions("lastWord"))
## S3 method for class 'ftable'
ToWrd(x, font = NULL, main = NULL, align = NULL,
method = "compact", ..., wrd = DescToolsOptions("lastWord"))
## S3 method for class 'TOne'
ToWrd(x, font = NULL, para = NULL, main = NULL, align = NULL,
autofit = TRUE, ..., wrd = DescToolsOptions("lastWord"))
## S3 method for class 'TMod'
ToWrd(x, font = NULL, para = NULL, main = NULL, align = NULL,
split = " ", fixed=TRUE, autofit = TRUE, digits = 3, na.form = "-", ...,
wrd = DescToolsOptions("lastWord"))
## S3 method for class 'lm'
ToWrd(x, font = NULL, ..., wrd = DescToolsOptions("lastWord"))
## S3 method for class 'character'
ToWrd(x, font = NULL, para = NULL, style = NULL, bullet = FALSE,
..., wrd = DescToolsOptions("lastWord"))
## Default S3 method:
ToWrd(x, font = NULL, ..., wrd = DescToolsOptions("lastWord"))
x |
the object to be transferred to Word. |
font |
the font to be used to the output. This should be defined as a list containing fontname, fontsize, bold and italic flags: |
para |
list containing paragraph format properties to be applied to the inserted text. For right align the paragraph one can set: |
main |
a caption for a table. This will be inserted by |
align |
character vector giving the alignment of the table columns. |
method |
string specifying how the
|
autofit |
logical, defining if the columns of table should be fitted to the length of their content. |
row.names |
logical, defining whether the row.names should be included in the output. Default is |
col.names |
logical, defining whether the col.names should be included in the output. Default is |
tablestyle |
either the name of a defined Word tablestyle or its index. |
style |
character, name of a style to be applied to the inserted text. |
... |
further arguments to be passed to or from methods. |
bullet |
logical, defines if the text should be formatted as bullet points. |
split |
character vector (or object which can be coerced to such) containing regular expression(s) (unless |
fixed |
logical. If TRUE match split exactly, otherwise use regular expressions. Has priority over perl. |
digits |
integer, the desired (fixed) number of digits after the decimal point. Unlike |
na.form |
character, string specifying how |
wrd |
the pointer to a word instance. Can be a new one, created by |
The paragraph format can be defined by means of these properties:
LeftIndent
, RightIndent
, SpaceBefore
, SpaceBeforeAuto
, SpaceAfter
, SpaceAfterAuto
, LineSpacingRule
,
Alignment
, WidowControl
, KeepWithNext
, KeepTogether
, PageBreakBefore
, NoLineNumber
, Hyphenation
,
FirstLineIndent
, OutlineLevel
, CharacterUnitLeftIndent
, CharacterUnitRightIndent
, CharacterUnitFirstLineIndent
,
LineUnitBefore
, LineUnitAfter
, MirrorIndents
.
if x
is a table a pointer to the table will be returned
Andri Signorell <andri@signorell.net>
GetNewWrd
## Not run:
# we can't get this through the CRAN test - run it with copy/paste to console
wrd <- GetNewWrd()
ToWrd("This is centered Text in Arial Black\n",
para=list(Alignment=wdConst$wdAlignParagraphCenter,
SpaceBefore=3, SpaceAfter=6),
font=list(name="Arial Black", size=14),
wrd=wrd)
sel <- wrd$Selection()$Borders(wdConst$wdBorderBottom)
sel[["LineStyle"]] <- wdConst$wdLineStyleSingle
t1 <- TOne(x = d.pizza[, c("temperature","delivery_min","driver","wine_ordered")],
grp=d.pizza$wine_delivered)
ToWrd(t1, font=list(name="Algerian"), wrd=wrd)
tab <- table(d.pizza$driver, d.pizza$area)
tab <- table(d.pizza$driver, d.pizza$area)
ToWrd(tab, font = list(size=15, name="Arial"), row.names = TRUE, col.names = TRUE,
main= "my Title", wrd=wrd)
ToWrd(tab, font = list(size=10, name="Arial narrow"),
row.names = TRUE, col.names=FALSE, wrd=wrd)
ToWrd(tab, font = list(size=15, name="Arial"), align="r",
row.names = FALSE, col.names=TRUE, wrd=wrd)
ToWrd(tab, font = list(size=15, name="Arial"),
row.names = FALSE, col.names=FALSE, wrd=wrd)
ToWrd(tab, tablestyle = "Mittlere Schattierung 2 - Akzent 4",
row.names=TRUE, col.names=TRUE, wrd=wrd)
ToWrd(Format(tab, big.mark = "'", digits=0), wrd=wrd)
zz <- ToWrd(Format(tab, big.mark = "'", digits=0), wrd=wrd)
zz$Rows(1)$Select()
WrdFont(wrd = wrd) <- list(name="Algerian", size=14, bold=TRUE)
# Send a TMod table to Word using a split to separate columns
r.ols <- lm(Fertility ~ . , swiss)
r.gam <- glm(Fertility ~ . , swiss, family=Gamma(link="identity"))
# Build the model table for some two models, creating a user defined
# reporting function (FUN) with | as column splitter
tm <- TMod(OLS=r.ols, Gamma=r.gam,
FUN=function(est, se, tval, pval, lci, uci){
gettextf("%s|[%s, %s]|%s",
Format(est, fmt=Fmt("num"), digits=2),
Format(lci, fmt=Fmt("num"), digits=2),
Format(uci, fmt=Fmt("num"), digits=2),
Format(pval, fmt="*")
)})
# send it to Word, where we get a table with 3 columns per model
# coef | confint | p-val
wrd <- GetNewWrd()
ToWrd(tm, split="|", align=StrSplit("lrclrcl"))
)
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.