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 Freq
ToWrd(x, font = NULL, main = NULL, ..., wrd = DescToolsOptions("lastWord"))
# S3 method for 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 data.frame
ToWrd(x, font = NULL, main = NULL, row.names = NULL, ...,
wrd = DescToolsOptions("lastWord"))
# S3 method for ftable
ToWrd(x, font = NULL, main = NULL, align = NULL,
method = "compact", ..., wrd = DescToolsOptions("lastWord"))
# S3 method for TOne
ToWrd(x, font = NULL, para = NULL, main = NULL, align = NULL,
autofit = TRUE, ..., wrd = DescToolsOptions("lastWord"))
# S3 method for 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 lm
ToWrd(x, font = NULL, ..., wrd = DescToolsOptions("lastWord"))
# S3 method for character
ToWrd(x, font = NULL, para = NULL, style = NULL, bullet = FALSE,
..., wrd = DescToolsOptions("lastWord"))
# S3 method for default
ToWrd(x, font = NULL, ..., wrd = DescToolsOptions("lastWord"))
if x
is a table a pointer to the table will be returned
the object to be transferred to Word.
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)
.
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.
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.
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.
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
.
logical, defining if the columns of table should be fitted to the length of their content.
logical, defining whether the row.names should be included in the output. Default is FALSE
.
logical, defining whether the col.names should be included in the output. Default is TRUE
.
either the name of a defined Word tablestyle or its index.
character, name of a style to be applied to the inserted text.
further arguments to be passed to or from methods.
logical, defines if the text should be formatted as bullet points.
character vector (or object which can be coerced to such) containing regular expression(s) (unless fixed = TRUE
) to use for splitting. If empty matches occur, in particular if split
has length 0, x is split into single characters. If split
has length greater than 1, it is re-cycled along x.
logical. If TRUE match split exactly, otherwise use regular expressions. Has priority over perl.
integer, the desired (fixed) number of digits after the decimal point. Unlike formatC
you will always get this number of digits even if the last digit is 0.
character, string specifying how NA
s should be specially formatted.
If set to NULL
(default) no special action will be taken.
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")
.
Andri Signorell <andri@signorell.net>
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
.
GetNewWrd