R: Send Objects to Word

ToWrd {DescTools} | R Documentation

## Send Objects to Word

### Description

Send objects like tables, ftables, lm tables, TOnes or just simple texts to a MS-Word document.

### Usage

    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 = FALSE, 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 '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"))

### Arguments

`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: `list(name="Arial", size=10, bold=FALSE, italic=TRUE)`.
`para` | list containing paragraph format properties to be applied to the inserted text. For right align the paragraph one can set: `list(alignment="r", LineBefore=0.5)`. See details for the full set of properties.
`main` | a caption for a table. This will be inserted by `WrdCaption` in Word and can be listed afterwards in a specific index. Default is `NULL`, which will insert nothing. Ignored if `x` is not a table.
`align` | character vector giving the alignment of the table columns. `"l"` means left, `"r"` right and `"c"` center alignement. The code will be recyled to the length of thenumber of columns.
`method` | string specifying how the `"ftable"` object is formatted (and printed if used as in `write.ftable()` or the `print` method). Can be abbreviated. Available methods are (see the examples): `"non.compact"` the default representation of an `"ftable"` object. `"row.compact"` a row-compact version without empty cells below the column labels. `"col.compact"` a column-compact version without empty cells to the right of the row labels. `"compact"` a row- and column-compact version. This may imply a row and a column label sharing the same cell. They are then separated by the string `lsep`.
`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 `FALSE`.
`col.names` | logical, defining whether the col.names should be included in the output. Default is `TRUE`.
`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.
`wrd` | the pointer to a word instance. Can be a new one, created by `GetNewWrd()` or an existing one, created by `GetCurrWrd()`. Default is the last created pointer stored in `DescToolsOptions("lastWord")`.

### Details

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`.

### Value

if `x` is a table a pointer to the table will be returned

### Author(s)

Andri Signorell <andri@signorell.net>

### See Also

`GetNewWrd`

### Examples

    ## 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)

    ## End(Not run)

[Package DescTools version 0.99.35 Index]