r2rtf: obj_rtf_text – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

r2rtf

obj_rtf_text

Create an RTF Text Object

Description

Create an RTF Text Object

Usage

obj_rtf_text(
  text,
  text_font = 1,
  text_format = NULL,
  text_font_size = 9,
  text_color = NULL,
  text_background_color = NULL,
  text_justification = "l",
  text_indent_first = 0,
  text_indent_left = 0,
  text_indent_right = 0,
  text_space = 1,
  text_space_before = 15,
  text_space_after = 15,
  text_new_page = FALSE,
  text_hyphenation = TRUE,
  text_convert = TRUE
)

Arguments

`text`	A character string.
`text_font`	Text font type. Default is 1 for Times New Roman. To vary text font type by column, use numeric vector with length of vector equal to number of columns displayed e.g. c(1,2,3).All possible input can be found in `r2rtf:::font_type()$type`.
`text_format`	Text format type. Default is NULL for normal. Combination of format type are permitted as input for e.g. "ub" for bold and underlined text. To vary text format by column, use character vector with length of vector equal to number of columns displayed e.g. c("i","u","ib"). All possible input can be found in `r2rtf:::font_format()$type`.
`text_font_size`	Text font size. Default is 9. To vary text font size by column, use numeric vector with length of vector equal to number of columns displayed e.g. c(9,20,40).
`text_color`	Text color type. Default is NULL for black. To vary text color by column, use character vector with length of vector equal to number of columns displayed e.g. c("white","red","blue"). All possible input can be found in `grDevices::colors()`.
`text_background_color`	Text background color type. Default is NULL for white. To vary text color by column, use character vector with length of vector equal to number of columns displayed e.g. c("white","red","blue"). All possible input can be found in `grDevices::colors()`.
`text_justification`	Justification type for text. Default is "c" for center justification. To vary text justification by column, use character vector with length of vector equal to number of columns displayed e.g. c("c","l","r"). All possible input can be found in `r2rtf:::justification()$type`.
`text_indent_first`	A value of first indent.
`text_indent_left`	A value of left indent.
`text_indent_right`	A value of right indent.
`text_space`	A value of text space.
`text_space_before`	Line space before text in twips. Default is 15 for 0.0104 inch.
`text_space_after`	Line space after text in twips. Default is 15 for 0.0104 inch.
`text_new_page`	A logical value to control whether display text in new page. Default is FALSE.
`text_hyphenation`	A logical value to control whether display text linked with hyphenation. Default is TRUE.
`text_convert`	A logical value to convert special characters. Default is TRUE.

Value

the same text (data frame or text) with additional attributes

Specification

The contents of this section are shown in PDF user manual only.

r2rtf

Easily Create Presentation-Ready Rich Text Format (RTF) Table and Figure

v0.2.0

GPL-3

Authors

Yilong Zhang [aut, cre], Siruo Wang [aut], Simiao Ye [aut], Madhusudhan Ginnaram [aut], Merck Sharp & Dohme Corp [cph]

Initial release

obj_rtf_text

Description

Usage

Arguments

Value

Specification

r2rtf

We don't support your browser anymore