Title: | Manipulation of Microsoft Word and PowerPoint Documents |
---|---|
Description: | Access and manipulate 'Microsoft Word', 'RTF' and 'Microsoft PowerPoint' documents from R. The package focuses on tabular and graphical reporting from R; it also provides two functions that let users get document content into data objects. A set of functions lets add and remove images, tables and paragraphs of text in new or existing documents. The package does not require any installation of Microsoft products to be able to write Microsoft files. |
Authors: | David Gohel [aut, cre], Stefan Moog [aut], Mark Heckmann [aut] , ArData [cph], Frank Hangler [ctb] (function body_replace_all_text), Liz Sander [ctb] (several documentation fixes), Anton Victorson [ctb] (fixes xml structures), Jon Calder [ctb] (update vignettes), John Harrold [ctb] (function annotate_base), John Muschelli [ctb] (google doc compatibility), Bill Denney [ctb] (<https://orcid.org/0000-0002-5759-428X>, function as.matrix.rpptx), Nikolai Beck [ctb] (set speaker notes for .pptx documents), Greg Leleu [ctb] (fields functionality in ppt), Majid Eismann [ctb], Hongyuan Jia [ctb] |
Maintainer: | David Gohel <[email protected]> |
License: | MIT + file LICENSE |
Version: | 0.6.8.001 |
Built: | 2024-10-31 18:25:48 UTC |
Source: | https://github.com/davidgohel/officer |
Add a sheet into an xlsx worksheet.
add_sheet(x, label)
add_sheet(x, label)
x |
rxlsx object |
label |
sheet label |
my_ws <- read_xlsx() my_pres <- add_sheet(my_ws, label = "new sheet")
my_ws <- read_xlsx() my_pres <- add_sheet(my_ws, label = "new sheet")
Add a slide into a pptx presentation.
add_slide(x, layout = "Title and Content", master = "Office Theme")
add_slide(x, layout = "Title and Content", master = "Office Theme")
x |
an rpptx object |
layout |
slide layout name to use |
master |
master layout name where |
print.rpptx()
, read_pptx()
, plot_layout_properties()
, ph_with()
, layout_summary()
Other functions slide manipulation:
move_slide()
,
on_slide()
,
remove_slide()
,
set_notes()
my_pres <- read_pptx() layout_summary(my_pres) my_pres <- add_slide(my_pres, layout = "Two Content", master = "Office Theme" )
my_pres <- read_pptx() layout_summary(my_pres) my_pres <- add_slide(my_pres, layout = "Two Content", master = "Office Theme" )
generates a slide from each layout in the base document to identify the placeholder indexes, types, names, master names and layout names.
This is to be used when need to know what parameters should be used with
ph_location*
calls. The parameters are printed in their corresponding shapes.
Note that if there are duplicated ph_label
, you should not use ph_location_label
.
Hint: You can dedupe labels using layout_dedupe_ph_labels
.
annotate_base(path = NULL, output_file = "annotated_layout.pptx")
annotate_base(path = NULL, output_file = "annotated_layout.pptx")
path |
path to the pptx file to use as base document or NULL to use the officer default |
output_file |
filename to store the annotated powerpoint file or NULL to suppress generation |
rpptx object of the annotated PowerPoint file
Other functions for reading presentation information:
color_scheme()
,
doc_properties()
,
layout_properties()
,
layout_summary()
,
length.rpptx()
,
plot_layout_properties()
,
slide_size()
,
slide_summary()
# To generate an anotation of the default base document with officer: annotate_base(output_file = tempfile(fileext = ".pptx")) # To generate an annotation of the base document 'mydoc.pptx' and place the # annotated output in 'mydoc_annotate.pptx' # annotate_base(path = 'mydoc.pptx', output_file='mydoc_annotate.pptx')
# To generate an anotation of the default base document with officer: annotate_base(output_file = tempfile(fileext = ".pptx")) # To generate an annotation of the base document 'mydoc.pptx' and place the # annotated output in 'mydoc_annotate.pptx' # annotate_base(path = 'mydoc.pptx', output_file='mydoc_annotate.pptx')
Convert the data in an a 'PowerPoint' table to a matrix or all data to a list of matrices.
## S3 method for class 'rpptx' as.matrix( x, ..., slide_id = NA_integer_, id = NA_character_, span = c(NA_character_, "fill") )
## S3 method for class 'rpptx' as.matrix( x, ..., slide_id = NA_integer_, id = NA_character_, span = c(NA_character_, "fill") )
x |
The rpptx object to convert (as created by
|
... |
Ignored |
slide_id |
The slide number to load from (NA indicates first slide with a table, NULL indicates all slides and all tables) |
id |
The table ID to load from (ignored it |
span |
How should col_span/row_span values be handled? |
A matrix with the data, or if slide_id=NULL
, a list of
matrices
library(officer) pptx_file <- system.file(package="officer", "doc_examples", "example.pptx") z <- read_pptx(pptx_file) as.matrix(z, slide_id = NULL)
library(officer) pptx_file <- system.file(package="officer", "doc_examples", "example.pptx") z <- read_pptx(pptx_file) as.matrix(z, slide_id = NULL)
A list of blocks can be used to gather several blocks (paragraphs, tables, ...) into a single object. The result can be added into a Word document or a PowerPoint presentation.
block_list(...)
block_list(...)
... |
a list of blocks. When output is only for
Word, objects of class |
ph_with()
, body_add_blocks()
, fpar()
Other block functions for reporting:
block_caption()
,
block_pour_docx()
,
block_section()
,
block_table()
,
block_toc()
,
fpar()
,
plot_instr()
,
unordered_list()
# block list ------ img.file <- file.path( R.home("doc"), "html", "logo.jpg" ) fpt_blue_bold <- fp_text(color = "#006699", bold = TRUE) fpt_red_italic <- fp_text(color = "#C32900", italic = TRUE) ## This can be only be used in a MS word output as pptx does ## not support paragraphs made of text and images. ## (actually it can be used but image will not appear in the ## pptx output) value <- block_list( fpar(ftext("hello world", fpt_blue_bold)), fpar(ftext("hello", fpt_blue_bold), " ", ftext("world", fpt_red_italic)), fpar( ftext("hello world", fpt_red_italic), external_img( src = img.file, height = 1.06, width = 1.39))) value doc <- read_docx() doc <- body_add(doc, value) print(doc, target = tempfile(fileext = ".docx")) value <- block_list( fpar(ftext("hello world", fpt_blue_bold)), fpar(ftext("hello", fpt_blue_bold), " ", ftext("world", fpt_red_italic)), fpar( ftext("blah blah blah", fpt_red_italic))) value doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(doc, value, location = ph_location_type(type = "body")) print(doc, target = tempfile(fileext = ".pptx"))
# block list ------ img.file <- file.path( R.home("doc"), "html", "logo.jpg" ) fpt_blue_bold <- fp_text(color = "#006699", bold = TRUE) fpt_red_italic <- fp_text(color = "#C32900", italic = TRUE) ## This can be only be used in a MS word output as pptx does ## not support paragraphs made of text and images. ## (actually it can be used but image will not appear in the ## pptx output) value <- block_list( fpar(ftext("hello world", fpt_blue_bold)), fpar(ftext("hello", fpt_blue_bold), " ", ftext("world", fpt_red_italic)), fpar( ftext("hello world", fpt_red_italic), external_img( src = img.file, height = 1.06, width = 1.39))) value doc <- read_docx() doc <- body_add(doc, value) print(doc, target = tempfile(fileext = ".docx")) value <- block_list( fpar(ftext("hello world", fpt_blue_bold)), fpar(ftext("hello", fpt_blue_bold), " ", ftext("world", fpt_red_italic)), fpar( ftext("blah blah blah", fpt_red_italic))) value doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(doc, value, location = ph_location_type(type = "body")) print(doc, target = tempfile(fileext = ".pptx"))
Pour the content of a docx file in the resulting docx from an 'R Markdown' document.
block_pour_docx(file)
block_pour_docx(file)
file |
external docx file path |
Other block functions for reporting:
block_caption()
,
block_list()
,
block_section()
,
block_table()
,
block_toc()
,
fpar()
,
plot_instr()
,
unordered_list()
library(officer) docx <- tempfile(fileext = ".docx") doc <- read_docx() doc <- body_add(doc, iris[1:20,], style = "table_template") print(doc, target = docx) target <- tempfile(fileext = ".docx") doc_1 <- read_docx() doc_1 <- body_add(doc_1, block_pour_docx(docx)) print(doc_1, target = target)
library(officer) docx <- tempfile(fileext = ".docx") doc <- read_docx() doc <- body_add(doc, iris[1:20,], style = "table_template") print(doc, target = docx) target <- tempfile(fileext = ".docx") doc_1 <- read_docx() doc_1 <- body_add(doc_1, block_pour_docx(docx)) print(doc_1, target = target)
Create a representation of a section.
A section affects preceding paragraphs or tables; i.e. a section starts at the end of the previous section (or the beginning of the document if no preceding section exists), and stops where the section is declared.
When a new landscape section is needed, it is recommended to add a block_section
with type = "continuous"
, to add the content to be appened in the new section
and finally to add a block_section with page_size = page_size(orient = "landscape")
.
block_section(property)
block_section(property)
property |
section properties defined with function prop_section |
Other block functions for reporting:
block_caption()
,
block_list()
,
block_pour_docx()
,
block_table()
,
block_toc()
,
fpar()
,
plot_instr()
,
unordered_list()
ps <- prop_section( page_size = page_size(orient = "landscape"), page_margins = page_mar(top = 2), type = "continuous" ) block_section(ps)
ps <- prop_section( page_size = page_size(orient = "landscape"), page_margins = page_mar(top = 2), type = "continuous" ) block_section(ps)
Create a representation of a table
block_table(x, header = TRUE, properties = prop_table(), alignment = NULL)
block_table(x, header = TRUE, properties = prop_table(), alignment = NULL)
x |
a data.frame to add as a table |
header |
display header if TRUE |
properties |
table properties, see |
alignment |
alignment for each columns, 'l' for left, 'r' for right and 'c' for center. Default to NULL. |
Other block functions for reporting:
block_caption()
,
block_list()
,
block_pour_docx()
,
block_section()
,
block_toc()
,
fpar()
,
plot_instr()
,
unordered_list()
block_table(x = head(iris)) block_table(x = mtcars, header = TRUE, properties = prop_table( tcf = table_conditional_formatting( first_row = TRUE, first_column = TRUE) ))
block_table(x = head(iris)) block_table(x = mtcars, header = TRUE, properties = prop_table( tcf = table_conditional_formatting( first_row = TRUE, first_column = TRUE) ))
Create a representation of a table of content for Word documents.
block_toc(level = 3, style = NULL, seq_id = NULL, separator = ";")
block_toc(level = 3, style = NULL, seq_id = NULL, separator = ";")
level |
max title level of the table |
style |
optional. If not NULL, its value is used as style in the document that will be used to build entries of the TOC. |
seq_id |
optional. If not NULL, its value is used as sequence
identifier in the document that will be used to build entries of the
TOC. See also |
separator |
optional. Some configurations need "," (i.e. from Canada) separator instead of ";" |
Other block functions for reporting:
block_caption()
,
block_list()
,
block_pour_docx()
,
block_section()
,
block_table()
,
fpar()
,
plot_instr()
,
unordered_list()
block_toc(level = 2) block_toc(style = "Table Caption")
block_toc(level = 2) block_toc(style = "Table Caption")
add a list of blocks produced by block_list
into
into an rdocx object.
body_add_blocks(x, blocks, pos = "after")
body_add_blocks(x, blocks, pos = "after")
x |
an rdocx object |
blocks |
set of blocks to be used as footnote content returned by
function |
pos |
where to add the new element relative to the cursor, one of "after", "before", "on". |
Other functions for adding content:
body_add_break()
,
body_add_caption()
,
body_add_docx()
,
body_add_fpar()
,
body_add_gg()
,
body_add_img()
,
body_add_par()
,
body_add_plot()
,
body_add_table()
,
body_add_toc()
library(officer) img.file <- file.path(R.home("doc"), "html", "logo.jpg") bl <- block_list( fpar(ftext("hello", shortcuts$fp_bold(color = "red"))), fpar( ftext("hello world", shortcuts$fp_bold()), external_img(src = img.file, height = 1.06, width = 1.39), fp_p = fp_par(text.align = "center") ) ) doc_1 <- read_docx() doc_1 <- body_add_blocks(doc_1, blocks = bl) print(doc_1, target = tempfile(fileext = ".docx"))
library(officer) img.file <- file.path(R.home("doc"), "html", "logo.jpg") bl <- block_list( fpar(ftext("hello", shortcuts$fp_bold(color = "red"))), fpar( ftext("hello world", shortcuts$fp_bold()), external_img(src = img.file, height = 1.06, width = 1.39), fp_p = fp_par(text.align = "center") ) ) doc_1 <- read_docx() doc_1 <- body_add_blocks(doc_1, blocks = bl) print(doc_1, target = tempfile(fileext = ".docx"))
add a page break into an rdocx object
body_add_break(x, pos = "after")
body_add_break(x, pos = "after")
x |
an rdocx object |
pos |
where to add the new element relative to the cursor, one of "after", "before", "on". |
Other functions for adding content:
body_add_blocks()
,
body_add_caption()
,
body_add_docx()
,
body_add_fpar()
,
body_add_gg()
,
body_add_img()
,
body_add_par()
,
body_add_plot()
,
body_add_table()
,
body_add_toc()
doc <- read_docx() doc <- body_add_break(doc) print(doc, target = tempfile(fileext = ".docx"))
doc <- read_docx() doc <- body_add_break(doc) print(doc, target = tempfile(fileext = ".docx"))
Add content of a docx into an rdocx object.
The function is using a 'Microsoft Word' feature: when the document will be edited, the content of the file will be inserted in the main document.
This feature is unlikely to work as expected if the resulting document is edited by another software.
The file is added when the method print()
that
produces the final Word file is called, so don't remove
file defined with src
before.
body_add_docx(x, src, pos = "after")
body_add_docx(x, src, pos = "after")
x |
an rdocx object |
src |
docx filename, the path of the file must not contain any '&' and the basename must not contain any space. |
pos |
where to add the new element relative to the cursor, one of "after", "before", "on". |
Other functions for adding content:
body_add_blocks()
,
body_add_break()
,
body_add_caption()
,
body_add_fpar()
,
body_add_gg()
,
body_add_img()
,
body_add_par()
,
body_add_plot()
,
body_add_table()
,
body_add_toc()
file1 <- tempfile(fileext = ".docx") file2 <- tempfile(fileext = ".docx") file3 <- tempfile(fileext = ".docx") x <- read_docx() x <- body_add_par(x, "hello world 1", style = "Normal") print(x, target = file1) x <- read_docx() x <- body_add_par(x, "hello world 2", style = "Normal") print(x, target = file2) x <- read_docx(path = file1) x <- body_add_break(x) x <- body_add_docx(x, src = file2) print(x, target = file3)
file1 <- tempfile(fileext = ".docx") file2 <- tempfile(fileext = ".docx") file3 <- tempfile(fileext = ".docx") x <- read_docx() x <- body_add_par(x, "hello world 1", style = "Normal") print(x, target = file1) x <- read_docx() x <- body_add_par(x, "hello world 2", style = "Normal") print(x, target = file2) x <- read_docx(path = file1) x <- body_add_break(x) x <- body_add_docx(x, src = file2) print(x, target = file3)
Add an fpar
(a formatted paragraph)
into an rdocx object.
body_add_fpar(x, value, style = NULL, pos = "after")
body_add_fpar(x, value, style = NULL, pos = "after")
x |
a docx device |
value |
a character |
style |
paragraph style. If NULL, paragraph settings from |
pos |
where to add the new element relative to the cursor, one of "after", "before", "on". |
Other functions for adding content:
body_add_blocks()
,
body_add_break()
,
body_add_caption()
,
body_add_docx()
,
body_add_gg()
,
body_add_img()
,
body_add_par()
,
body_add_plot()
,
body_add_table()
,
body_add_toc()
bold_face <- shortcuts$fp_bold(font.size = 30) bold_redface <- update(bold_face, color = "red") fpar_ <- fpar( ftext("Hello ", prop = bold_face), ftext("World", prop = bold_redface), ftext(", how are you?", prop = bold_face) ) doc <- read_docx() doc <- body_add_fpar(doc, fpar_) print(doc, target = tempfile(fileext = ".docx")) # a way of using fpar to center an image in a Word doc ---- rlogo <- file.path(R.home("doc"), "html", "logo.jpg") img_in_par <- fpar( external_img(src = rlogo, height = 1.06 / 2, width = 1.39 / 2), hyperlink_ftext( href = "https://cran.r-project.org/index.html", text = "cran", prop = bold_redface ), fp_p = fp_par(text.align = "center") ) doc <- read_docx() doc <- body_add_fpar(doc, img_in_par) print(doc, target = tempfile(fileext = ".docx"))
bold_face <- shortcuts$fp_bold(font.size = 30) bold_redface <- update(bold_face, color = "red") fpar_ <- fpar( ftext("Hello ", prop = bold_face), ftext("World", prop = bold_redface), ftext(", how are you?", prop = bold_face) ) doc <- read_docx() doc <- body_add_fpar(doc, fpar_) print(doc, target = tempfile(fileext = ".docx")) # a way of using fpar to center an image in a Word doc ---- rlogo <- file.path(R.home("doc"), "html", "logo.jpg") img_in_par <- fpar( external_img(src = rlogo, height = 1.06 / 2, width = 1.39 / 2), hyperlink_ftext( href = "https://cran.r-project.org/index.html", text = "cran", prop = bold_redface ), fp_p = fp_par(text.align = "center") ) doc <- read_docx() doc <- body_add_fpar(doc, img_in_par) print(doc, target = tempfile(fileext = ".docx"))
add a ggplot as a png image into an rdocx object.
body_add_gg( x, value, width = 6, height = 5, res = 300, style = "Normal", scale = 1, pos = "after", ... )
body_add_gg( x, value, width = 6, height = 5, res = 300, style = "Normal", scale = 1, pos = "after", ... )
x |
an rdocx object |
value |
ggplot object |
width |
height in inches |
height |
height in inches |
res |
resolution of the png image in ppi |
style |
paragraph style |
scale |
Multiplicative scaling factor, same as in ggsave |
pos |
where to add the new element relative to the cursor, one of "after", "before", "on". |
... |
Arguments to be passed to png function. |
Other functions for adding content:
body_add_blocks()
,
body_add_break()
,
body_add_caption()
,
body_add_docx()
,
body_add_fpar()
,
body_add_img()
,
body_add_par()
,
body_add_plot()
,
body_add_table()
,
body_add_toc()
if (require("ggplot2")) { doc <- read_docx() gg_plot <- ggplot(data = iris) + geom_point(mapping = aes(Sepal.Length, Petal.Length)) if (capabilities(what = "png")) { doc <- body_add_gg(doc, value = gg_plot, style = "centered") } print(doc, target = tempfile(fileext = ".docx")) }
if (require("ggplot2")) { doc <- read_docx() gg_plot <- ggplot(data = iris) + geom_point(mapping = aes(Sepal.Length, Petal.Length)) if (capabilities(what = "png")) { doc <- body_add_gg(doc, value = gg_plot, style = "centered") } print(doc, target = tempfile(fileext = ".docx")) }
add an image into an rdocx object.
body_add_img(x, src, style = NULL, width, height, pos = "after")
body_add_img(x, src, style = NULL, width, height, pos = "after")
x |
an rdocx object |
src |
image filename, the basename of the file must not contain any blank. |
style |
paragraph style |
width |
height in inches |
height |
height in inches |
pos |
where to add the new element relative to the cursor, one of "after", "before", "on". |
Other functions for adding content:
body_add_blocks()
,
body_add_break()
,
body_add_caption()
,
body_add_docx()
,
body_add_fpar()
,
body_add_gg()
,
body_add_par()
,
body_add_plot()
,
body_add_table()
,
body_add_toc()
doc <- read_docx() img.file <- file.path(R.home("doc"), "html", "logo.jpg") if (file.exists(img.file)) { doc <- body_add_img(x = doc, src = img.file, height = 1.06, width = 1.39) } print(doc, target = tempfile(fileext = ".docx"))
doc <- read_docx() img.file <- file.path(R.home("doc"), "html", "logo.jpg") if (file.exists(img.file)) { doc <- body_add_img(x = doc, src = img.file, height = 1.06, width = 1.39) } print(doc, target = tempfile(fileext = ".docx"))
add a paragraph of text into an rdocx object
body_add_par(x, value, style = NULL, pos = "after")
body_add_par(x, value, style = NULL, pos = "after")
x |
a docx device |
value |
a character |
style |
paragraph style name |
pos |
where to add the new element relative to the cursor, one of "after", "before", "on". |
Other functions for adding content:
body_add_blocks()
,
body_add_break()
,
body_add_caption()
,
body_add_docx()
,
body_add_fpar()
,
body_add_gg()
,
body_add_img()
,
body_add_plot()
,
body_add_table()
,
body_add_toc()
doc <- read_docx() doc <- body_add_par(doc, "A title", style = "heading 1") doc <- body_add_par(doc, "Hello world!", style = "Normal") doc <- body_add_par(doc, "centered text", style = "centered") print(doc, target = tempfile(fileext = ".docx"))
doc <- read_docx() doc <- body_add_par(doc, "A title", style = "heading 1") doc <- body_add_par(doc, "Hello world!", style = "Normal") doc <- body_add_par(doc, "centered text", style = "centered") print(doc, target = tempfile(fileext = ".docx"))
Add a plot as a png image into an rdocx object.
body_add_plot( x, value, width = 6, height = 5, res = 300, style = "Normal", pos = "after", ... )
body_add_plot( x, value, width = 6, height = 5, res = 300, style = "Normal", pos = "after", ... )
x |
an rdocx object |
value |
plot instructions, see |
width |
height in inches |
height |
height in inches |
res |
resolution of the png image in ppi |
style |
paragraph style |
pos |
where to add the new element relative to the cursor, one of "after", "before", "on". |
... |
Arguments to be passed to png function. |
Other functions for adding content:
body_add_blocks()
,
body_add_break()
,
body_add_caption()
,
body_add_docx()
,
body_add_fpar()
,
body_add_gg()
,
body_add_img()
,
body_add_par()
,
body_add_table()
,
body_add_toc()
doc <- read_docx() if (capabilities(what = "png")) { doc <- body_add_plot(doc, value = plot_instr( code = { barplot(1:5, col = 2:6) } ), style = "centered" ) } print(doc, target = tempfile(fileext = ".docx"))
doc <- read_docx() if (capabilities(what = "png")) { doc <- body_add_plot(doc, value = plot_instr( code = { barplot(1:5, col = 2:6) } ), style = "centered" ) } print(doc, target = tempfile(fileext = ".docx"))
Add a table into an rdocx object.
body_add_table( x, value, style = NULL, pos = "after", header = TRUE, alignment = NULL, align_table = "center", stylenames = table_stylenames(), first_row = TRUE, first_column = FALSE, last_row = FALSE, last_column = FALSE, no_hband = FALSE, no_vband = TRUE )
body_add_table( x, value, style = NULL, pos = "after", header = TRUE, alignment = NULL, align_table = "center", stylenames = table_stylenames(), first_row = TRUE, first_column = FALSE, last_row = FALSE, last_column = FALSE, no_hband = FALSE, no_vband = TRUE )
x |
a docx device |
value |
a data.frame to add as a table |
style |
table style |
pos |
where to add the new element relative to the cursor, one of after", "before", "on". |
header |
display header if TRUE |
alignment |
columns alignement, argument length must match with columns length, values must be "l" (left), "r" (right) or "c" (center). |
align_table |
table alignment within document, value must be "left", "center" or "right" |
stylenames |
columns styles defined by |
first_row |
Specifies that the first column conditional formatting should be applied. Details for this and other conditional formatting options can be found at http://officeopenxml.com/WPtblLook.php. |
first_column |
Specifies that the first column conditional formatting should be applied. |
last_row |
Specifies that the first column conditional formatting should be applied. |
last_column |
Specifies that the first column conditional formatting should be applied. |
no_hband |
Specifies that the first column conditional formatting should be applied. |
no_vband |
Specifies that the first column conditional formatting should be applied. |
Other functions for adding content:
body_add_blocks()
,
body_add_break()
,
body_add_caption()
,
body_add_docx()
,
body_add_fpar()
,
body_add_gg()
,
body_add_img()
,
body_add_par()
,
body_add_plot()
,
body_add_toc()
doc <- read_docx() doc <- body_add_table(doc, iris, style = "table_template") print(doc, target = tempfile(fileext = ".docx"))
doc <- read_docx() doc <- body_add_table(doc, iris, style = "table_template") print(doc, target = tempfile(fileext = ".docx"))
Add a table of content into an rdocx object. The TOC will be generated by Word, if the document is not edited with Word (i.e. Libre Office) the TOC will not be generated.
body_add_toc(x, level = 3, pos = "after", style = NULL, separator = ";")
body_add_toc(x, level = 3, pos = "after", style = NULL, separator = ";")
x |
an rdocx object |
level |
max title level of the table |
pos |
where to add the new element relative to the cursor, one of "after", "before", "on". |
style |
optional. style in the document that will be used to build entries of the TOC. |
separator |
optional. Some configurations need "," (i.e. from Canada) separator instead of ";" |
Other functions for adding content:
body_add_blocks()
,
body_add_break()
,
body_add_caption()
,
body_add_docx()
,
body_add_fpar()
,
body_add_gg()
,
body_add_img()
,
body_add_par()
,
body_add_plot()
,
body_add_table()
doc <- read_docx() doc <- body_add_toc(doc) print(doc, target = tempfile(fileext = ".docx"))
doc <- read_docx() doc <- body_add_toc(doc) print(doc, target = tempfile(fileext = ".docx"))
Add a bookmark at the cursor location. The bookmark is added on the first run of text in the current paragraph.
body_bookmark(x, id)
body_bookmark(x, id)
x |
an rdocx object |
id |
bookmark name |
# cursor_bookmark ---- doc <- read_docx() doc <- body_add_par(doc, "centered text", style = "centered") doc <- body_bookmark(doc, "text_to_replace")
# cursor_bookmark ---- doc <- read_docx() doc <- body_add_par(doc, "centered text", style = "centered") doc <- body_bookmark(doc, "text_to_replace")
Add a comment at the cursor location. The comment is added on the first run of text in the current paragraph.
body_comment(x, cmt = ftext(""), author = "", date = "", initials = "")
body_comment(x, cmt = ftext(""), author = "", date = "", initials = "")
x |
an rdocx object |
cmt |
a set of blocks to be used as comment content returned by
function |
author |
comment author. |
date |
comment date |
initials |
comment initials |
doc <- read_docx() doc <- body_add_par(doc, "Paragraph") doc <- body_comment(doc, block_list("This is a comment.")) docx_file <- print(doc, target = tempfile(fileext = ".docx")) docx_comments(read_docx(docx_file))
doc <- read_docx() doc <- body_add_par(doc, "Paragraph") doc <- body_comment(doc, block_list("This is a comment.")) docx_file <- print(doc, target = tempfile(fileext = ".docx")) docx_comments(read_docx(docx_file))
Add a section to the document. You can
define any section with a block_section object. All other
body_end_section_*
are specialized, this one is highly flexible
but it's up to the user to define the section properties.
body_end_block_section(x, value)
body_end_block_section(x, value)
x |
an rdocx object |
value |
a block_section object |
Other functions for Word sections:
body_end_section_columns()
,
body_end_section_columns_landscape()
,
body_end_section_continuous()
,
body_end_section_landscape()
,
body_end_section_portrait()
,
body_set_default_section()
library(officer) str1 <- "Lorem ipsum dolor sit amet, consectetur adipiscing elit." str1 <- rep(str1, 20) str1 <- paste(str1, collapse = " ") ps <- prop_section( page_size = page_size(orient = "landscape"), page_margins = page_mar(top = 2), type = "continuous" ) doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_end_block_section(doc_1, block_section(ps)) doc_1 <- body_add_par(doc_1, value = str1, style = "centered") print(doc_1, target = tempfile(fileext = ".docx"))
library(officer) str1 <- "Lorem ipsum dolor sit amet, consectetur adipiscing elit." str1 <- rep(str1, 20) str1 <- paste(str1, collapse = " ") ps <- prop_section( page_size = page_size(orient = "landscape"), page_margins = page_mar(top = 2), type = "continuous" ) doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_end_block_section(doc_1, block_section(ps)) doc_1 <- body_add_par(doc_1, value = str1, style = "centered") print(doc_1, target = tempfile(fileext = ".docx"))
A section with multiple columns is added to the document.
You may prefer to use body_end_block_section()
that is
more flexible.
body_end_section_columns(x, widths = c(2.5, 2.5), space = 0.25, sep = FALSE)
body_end_section_columns(x, widths = c(2.5, 2.5), space = 0.25, sep = FALSE)
x |
an rdocx object |
widths |
columns widths in inches. If 3 values, 3 columns will be produced. |
space |
space in inches between columns. |
sep |
if TRUE a line is separating columns. |
Other functions for Word sections:
body_end_block_section()
,
body_end_section_columns_landscape()
,
body_end_section_continuous()
,
body_end_section_landscape()
,
body_end_section_portrait()
,
body_set_default_section()
str1 <- "Lorem ipsum dolor sit amet, consectetur adipiscing elit." str1 <- rep(str1, 5) str1 <- paste(str1, collapse = " ") doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_end_section_columns(doc_1) doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") print(doc_1, target = tempfile(fileext = ".docx"))
str1 <- "Lorem ipsum dolor sit amet, consectetur adipiscing elit." str1 <- rep(str1, 5) str1 <- paste(str1, collapse = " ") doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_end_section_columns(doc_1) doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") print(doc_1, target = tempfile(fileext = ".docx"))
A landscape section with multiple columns is added to the document.
body_end_section_columns_landscape( x, widths = c(2.5, 2.5), space = 0.25, sep = FALSE, w = 21/2.54, h = 29.7/2.54 )
body_end_section_columns_landscape( x, widths = c(2.5, 2.5), space = 0.25, sep = FALSE, w = 21/2.54, h = 29.7/2.54 )
x |
an rdocx object |
widths |
columns widths in inches. If 3 values, 3 columns will be produced. |
space |
space in inches between columns. |
sep |
if TRUE a line is separating columns. |
w , h
|
page width, page height (in inches) |
Other functions for Word sections:
body_end_block_section()
,
body_end_section_columns()
,
body_end_section_continuous()
,
body_end_section_landscape()
,
body_end_section_portrait()
,
body_set_default_section()
str1 <- "Lorem ipsum dolor sit amet, consectetur adipiscing elit." str1 <- rep(str1, 5) str1 <- paste(str1, collapse = " ") doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_end_section_columns_landscape(doc_1, widths = c(6, 2)) doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") print(doc_1, target = tempfile(fileext = ".docx"))
str1 <- "Lorem ipsum dolor sit amet, consectetur adipiscing elit." str1 <- rep(str1, 5) str1 <- paste(str1, collapse = " ") doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_end_section_columns_landscape(doc_1, widths = c(6, 2)) doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") print(doc_1, target = tempfile(fileext = ".docx"))
Section break starts the new section on the same page. This type of section break is often used to change the number of columns without starting a new page.
body_end_section_continuous(x)
body_end_section_continuous(x)
x |
an rdocx object |
Other functions for Word sections:
body_end_block_section()
,
body_end_section_columns()
,
body_end_section_columns_landscape()
,
body_end_section_landscape()
,
body_end_section_portrait()
,
body_set_default_section()
str1 <- "Lorem ipsum dolor sit amet, consectetur adipiscing elit." str1 <- rep(str1, 5) str1 <- paste(str1, collapse = " ") str2 <- "Aenean venenatis varius elit et fermentum vivamus vehicula." str2 <- rep(str2, 5) str2 <- paste(str2, collapse = " ") doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, value = "Default section", style = "heading 1") doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_add_par(doc_1, value = str2, style = "Normal") doc_1 <- body_end_section_continuous(doc_1) print(doc_1, target = tempfile(fileext = ".docx"))
str1 <- "Lorem ipsum dolor sit amet, consectetur adipiscing elit." str1 <- rep(str1, 5) str1 <- paste(str1, collapse = " ") str2 <- "Aenean venenatis varius elit et fermentum vivamus vehicula." str2 <- rep(str2, 5) str2 <- paste(str2, collapse = " ") doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, value = "Default section", style = "heading 1") doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_add_par(doc_1, value = str2, style = "Normal") doc_1 <- body_end_section_continuous(doc_1) print(doc_1, target = tempfile(fileext = ".docx"))
A section with landscape orientation is added to the document.
body_end_section_landscape(x, w = 21/2.54, h = 29.7/2.54)
body_end_section_landscape(x, w = 21/2.54, h = 29.7/2.54)
x |
an rdocx object |
w , h
|
page width, page height (in inches) |
Other functions for Word sections:
body_end_block_section()
,
body_end_section_columns()
,
body_end_section_columns_landscape()
,
body_end_section_continuous()
,
body_end_section_portrait()
,
body_set_default_section()
str1 <- "Lorem ipsum dolor sit amet, consectetur adipiscing elit." str1 <- rep(str1, 5) str1 <- paste(str1, collapse = " ") doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_end_section_landscape(doc_1) print(doc_1, target = tempfile(fileext = ".docx"))
str1 <- "Lorem ipsum dolor sit amet, consectetur adipiscing elit." str1 <- rep(str1, 5) str1 <- paste(str1, collapse = " ") doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_end_section_landscape(doc_1) print(doc_1, target = tempfile(fileext = ".docx"))
A section with portrait orientation is added to the document.
body_end_section_portrait(x, w = 21/2.54, h = 29.7/2.54)
body_end_section_portrait(x, w = 21/2.54, h = 29.7/2.54)
x |
an rdocx object |
w , h
|
page width, page height (in inches) |
Other functions for Word sections:
body_end_block_section()
,
body_end_section_columns()
,
body_end_section_columns_landscape()
,
body_end_section_continuous()
,
body_end_section_landscape()
,
body_set_default_section()
str1 <- "Lorem ipsum dolor sit amet, consectetur adipiscing elit." str1 <- rep(str1, 5) str1 <- paste(str1, collapse = " ") doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_end_section_portrait(doc_1) doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") print(doc_1, target = tempfile(fileext = ".docx"))
str1 <- "Lorem ipsum dolor sit amet, consectetur adipiscing elit." str1 <- rep(str1, 5) str1 <- paste(str1, collapse = " ") doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") doc_1 <- body_end_section_portrait(doc_1) doc_1 <- body_add_par(doc_1, value = str1, style = "Normal") print(doc_1, target = tempfile(fileext = ".docx"))
Remove element pointed by cursor from a 'Word' document.
body_remove(x)
body_remove(x)
x |
an rdocx object |
library(officer) str1 <- rep("Lorem ipsum dolor sit amet, consectetur adipiscing elit. ", 20) str1 <- paste(str1, collapse = "") str2 <- "Drop that text" str3 <- rep("Aenean venenatis varius elit et fermentum vivamus vehicula. ", 20) str3 <- paste(str3, collapse = "") my_doc <- read_docx() my_doc <- body_add_par(my_doc, value = str1, style = "Normal") my_doc <- body_add_par(my_doc, value = str2, style = "centered") my_doc <- body_add_par(my_doc, value = str3, style = "Normal") new_doc_file <- print(my_doc, target = tempfile(fileext = ".docx") ) my_doc <- read_docx(path = new_doc_file) my_doc <- cursor_reach(my_doc, keyword = "that text") my_doc <- body_remove(my_doc) print(my_doc, target = tempfile(fileext = ".docx"))
library(officer) str1 <- rep("Lorem ipsum dolor sit amet, consectetur adipiscing elit. ", 20) str1 <- paste(str1, collapse = "") str2 <- "Drop that text" str3 <- rep("Aenean venenatis varius elit et fermentum vivamus vehicula. ", 20) str3 <- paste(str3, collapse = "") my_doc <- read_docx() my_doc <- body_add_par(my_doc, value = str1, style = "Normal") my_doc <- body_add_par(my_doc, value = str2, style = "centered") my_doc <- body_add_par(my_doc, value = str3, style = "Normal") new_doc_file <- print(my_doc, target = tempfile(fileext = ".docx") ) my_doc <- read_docx(path = new_doc_file) my_doc <- cursor_reach(my_doc, keyword = "that text") my_doc <- body_remove(my_doc) print(my_doc, target = tempfile(fileext = ".docx"))
Replace text anywhere in the document, or at a cursor.
Replace all occurrences of old_value with new_value. This method
uses grepl
/gsub
for pattern matching; you may
supply arguments as required (and therefore use regex
features)
using the optional ...
argument.
Note that by default, grepl/gsub will use fixed=FALSE
, which means
that old_value
and new_value
will be interepreted as regular
expressions.
Chunking of text
Note that the behind-the-scenes representation of text in a Word document is frequently not what you might expect! Sometimes a paragraph of text is broken up (or "chunked") into several "runs," as a result of style changes, pauses in text entry, later revisions and edits, etc. If you have not styled the text, and have entered it in an "all-at-once" fashion, e.g. by pasting it or by outputing it programmatically into your Word document, then this will likely not be a problem. If you are working with a manually-edited document, however, this can lead to unexpected failures to find text.
You can use the officer function docx_show_chunk
to
show how the paragraph of text at the current cursor has been chunked into
runs, and what text is in each chunk. This can help troubleshoot unexpected
failures to find text.
body_replace_all_text( x, old_value, new_value, only_at_cursor = FALSE, warn = TRUE, ... ) headers_replace_all_text( x, old_value, new_value, only_at_cursor = FALSE, warn = TRUE, ... ) footers_replace_all_text( x, old_value, new_value, only_at_cursor = FALSE, warn = TRUE, ... )
body_replace_all_text( x, old_value, new_value, only_at_cursor = FALSE, warn = TRUE, ... ) headers_replace_all_text( x, old_value, new_value, only_at_cursor = FALSE, warn = TRUE, ... ) footers_replace_all_text( x, old_value, new_value, only_at_cursor = FALSE, warn = TRUE, ... )
x |
a docx device |
old_value |
the value to replace |
new_value |
the value to replace it with |
only_at_cursor |
if |
warn |
warn if |
... |
optional arguments to grepl/gsub (e.g. |
Replacements will be performed in each header of all sections.
Replacements will be performed in each footer of all sections.
Frank Hangler, [email protected]
doc <- read_docx() doc <- body_add_par(doc, "Placeholder one") doc <- body_add_par(doc, "Placeholder two") # Show text chunk at cursor docx_show_chunk(doc) # Output is 'Placeholder two' # Simple search-and-replace at current cursor, with regex turned off doc <- body_replace_all_text(doc, old_value = "Placeholder", new_value = "new", only_at_cursor = TRUE, fixed = TRUE) docx_show_chunk(doc) # Output is 'new two' # Do the same, but in the entire document and ignoring case doc <- body_replace_all_text(doc, old_value = "placeholder", new_value = "new", only_at_cursor=FALSE, ignore.case = TRUE) doc <- cursor_backward(doc) docx_show_chunk(doc) # Output is 'new one' # Use regex : replace all words starting with "n" with the word "example" doc <- body_replace_all_text(doc, "\\bn.*?\\b", "example") docx_show_chunk(doc) # Output is 'example one'
doc <- read_docx() doc <- body_add_par(doc, "Placeholder one") doc <- body_add_par(doc, "Placeholder two") # Show text chunk at cursor docx_show_chunk(doc) # Output is 'Placeholder two' # Simple search-and-replace at current cursor, with regex turned off doc <- body_replace_all_text(doc, old_value = "Placeholder", new_value = "new", only_at_cursor = TRUE, fixed = TRUE) docx_show_chunk(doc) # Output is 'new two' # Do the same, but in the entire document and ignoring case doc <- body_replace_all_text(doc, old_value = "placeholder", new_value = "new", only_at_cursor=FALSE, ignore.case = TRUE) doc <- cursor_backward(doc) docx_show_chunk(doc) # Output is 'new one' # Use regex : replace all words starting with "n" with the word "example" doc <- body_replace_all_text(doc, "\\bn.*?\\b", "example") docx_show_chunk(doc) # Output is 'example one'
Use these functions if you want to replace a paragraph containing a bookmark with a 'ggplot' or a base plot.
body_replace_gg_at_bkm( x, bookmark, value, width = 6, height = 5, res = 300, style = "Normal", scale = 1, keep = FALSE, ... ) body_replace_plot_at_bkm( x, bookmark, value, width = 6, height = 5, res = 300, style = "Normal", keep = FALSE, ... )
body_replace_gg_at_bkm( x, bookmark, value, width = 6, height = 5, res = 300, style = "Normal", scale = 1, keep = FALSE, ... ) body_replace_plot_at_bkm( x, bookmark, value, width = 6, height = 5, res = 300, style = "Normal", keep = FALSE, ... )
x |
an rdocx object |
bookmark |
bookmark id |
value |
a ggplot object for body_replace_gg_at_bkm() or a set plot instructions body_replace_plot_at_bkm(), see plot_instr(). |
width |
height in inches |
height |
height in inches |
res |
resolution of the png image in ppi |
style |
paragraph style |
scale |
Multiplicative scaling factor, same as in ggsave |
keep |
Should the bookmark be preserved? Defaults to |
... |
Arguments to be passed to png function. |
if (require("ggplot2")) { gg_plot <- ggplot(data = iris) + geom_point(mapping = aes(Sepal.Length, Petal.Length)) doc <- read_docx() doc <- body_add_par(doc, "insert_plot_here") doc <- body_bookmark(doc, "plot") doc <- body_replace_gg_at_bkm(doc, bookmark = "plot", value = gg_plot) print(doc, target = tempfile(fileext = ".docx")) } doc <- read_docx() doc <- body_add_par(doc, "insert_plot_here") doc <- body_bookmark(doc, "plot") if (capabilities(what = "png")) { doc <- body_replace_plot_at_bkm( doc, bookmark = "plot", value = plot_instr( code = { barplot(1:5, col = 2:6) } ) ) } print(doc, target = tempfile(fileext = ".docx"))
if (require("ggplot2")) { gg_plot <- ggplot(data = iris) + geom_point(mapping = aes(Sepal.Length, Petal.Length)) doc <- read_docx() doc <- body_add_par(doc, "insert_plot_here") doc <- body_bookmark(doc, "plot") doc <- body_replace_gg_at_bkm(doc, bookmark = "plot", value = gg_plot) print(doc, target = tempfile(fileext = ".docx")) } doc <- read_docx() doc <- body_add_par(doc, "insert_plot_here") doc <- body_bookmark(doc, "plot") if (capabilities(what = "png")) { doc <- body_replace_plot_at_bkm( doc, bookmark = "plot", value = plot_instr( code = { barplot(1:5, col = 2:6) } ) ) } print(doc, target = tempfile(fileext = ".docx"))
Replace text content enclosed in a bookmark with different text. A bookmark will be considered as valid if enclosing words within a paragraph; i.e., a bookmark along two or more paragraphs is invalid, a bookmark set on a whole paragraph is also invalid, but bookmarking few words inside a paragraph is valid.
body_replace_text_at_bkm(x, bookmark, value) body_replace_img_at_bkm(x, bookmark, value) headers_replace_text_at_bkm(x, bookmark, value) headers_replace_img_at_bkm(x, bookmark, value) footers_replace_text_at_bkm(x, bookmark, value) footers_replace_img_at_bkm(x, bookmark, value)
body_replace_text_at_bkm(x, bookmark, value) body_replace_img_at_bkm(x, bookmark, value) headers_replace_text_at_bkm(x, bookmark, value) headers_replace_img_at_bkm(x, bookmark, value) footers_replace_text_at_bkm(x, bookmark, value) footers_replace_img_at_bkm(x, bookmark, value)
x |
a docx device |
bookmark |
bookmark id |
value |
the replacement string, of type character |
doc <- read_docx() doc <- body_add_par(doc, "a paragraph to replace", style = "centered") doc <- body_bookmark(doc, "text_to_replace") doc <- body_replace_text_at_bkm(doc, "text_to_replace", "new text") # demo usage of bookmark and images ---- template <- system.file(package = "officer", "doc_examples/example.docx") img.file <- file.path( R.home("doc"), "html", "logo.jpg" ) doc <- read_docx(path = template) doc <- headers_replace_img_at_bkm(x = doc, bookmark = "bmk_header", value = external_img(src = img.file, width = .53, height = .7)) doc <- footers_replace_img_at_bkm(x = doc, bookmark = "bmk_footer", value = external_img(src = img.file, width = .53, height = .7)) print(doc, target = tempfile(fileext = ".docx"))
doc <- read_docx() doc <- body_add_par(doc, "a paragraph to replace", style = "centered") doc <- body_bookmark(doc, "text_to_replace") doc <- body_replace_text_at_bkm(doc, "text_to_replace", "new text") # demo usage of bookmark and images ---- template <- system.file(package = "officer", "doc_examples/example.docx") img.file <- file.path( R.home("doc"), "html", "logo.jpg" ) doc <- read_docx(path = template) doc <- headers_replace_img_at_bkm(x = doc, bookmark = "bmk_header", value = external_img(src = img.file, width = .53, height = .7)) doc <- footers_replace_img_at_bkm(x = doc, bookmark = "bmk_footer", value = external_img(src = img.file, width = .53, height = .7)) print(doc, target = tempfile(fileext = ".docx"))
Define default section of the document. You can define section propeerties (page size, orientation, ...) with a prop_section object.
body_set_default_section(x, value)
body_set_default_section(x, value)
x |
an rdocx object |
value |
a prop_section object |
Other functions for Word sections:
body_end_block_section()
,
body_end_section_columns()
,
body_end_section_columns_landscape()
,
body_end_section_continuous()
,
body_end_section_landscape()
,
body_end_section_portrait()
default_sect_properties <- prop_section( page_size = page_size(orient = "landscape"), type = "continuous", page_margins = page_mar(bottom = .75, top = 1.5, right = 2, left = 2) ) doc_1 <- read_docx() doc_1 <- body_add_table(doc_1, value = mtcars[1:10, ], style = "table_template") doc_1 <- body_add_par(doc_1, value = paste(rep(letters, 40), collapse = " ")) doc_1 <- body_set_default_section(doc_1, default_sect_properties) print(doc_1, target = tempfile(fileext = ".docx"))
default_sect_properties <- prop_section( page_size = page_size(orient = "landscape"), type = "continuous", page_margins = page_mar(bottom = .75, top = 1.5, right = 2, left = 2) ) doc_1 <- read_docx() doc_1 <- body_add_table(doc_1, value = mtcars[1:10, ], style = "table_template") doc_1 <- body_add_par(doc_1, value = paste(rep(letters, 40), collapse = " ")) doc_1 <- body_set_default_section(doc_1, default_sect_properties) print(doc_1, target = tempfile(fileext = ".docx"))
Replace styles with others in a 'Word' document. This function can be used for paragraph, run/character and table styles.
change_styles(x, mapstyles)
change_styles(x, mapstyles)
x |
an rdocx object |
mapstyles |
a named list, names are the replacement style,
content (as a character vector) are the styles to be replaced.
Use |
# creating a sample docx so that we can illustrate how # to change styles doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, "A title", style = "heading 1") doc_1 <- body_add_par(doc_1, "Another title", style = "heading 2") doc_1 <- body_add_par(doc_1, "Hello world!", style = "Normal") file <- print(doc_1, target = tempfile(fileext = ".docx")) # now we can illustrate how # to change styles with `change_styles` doc_2 <- read_docx(path = file) mapstyles <- list( "centered" = c("Normal", "heading 2"), "strong" = "Default Paragraph Font" ) doc_2 <- change_styles(doc_2, mapstyles = mapstyles) print(doc_2, target = tempfile(fileext = ".docx"))
# creating a sample docx so that we can illustrate how # to change styles doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, "A title", style = "heading 1") doc_1 <- body_add_par(doc_1, "Another title", style = "heading 2") doc_1 <- body_add_par(doc_1, "Hello world!", style = "Normal") file <- print(doc_1, target = tempfile(fileext = ".docx")) # now we can illustrate how # to change styles with `change_styles` doc_2 <- read_docx(path = file) mapstyles <- list( "centered" = c("Normal", "heading 2"), "strong" = "Default Paragraph Font" ) doc_2 <- change_styles(doc_2, mapstyles = mapstyles) print(doc_2, target = tempfile(fileext = ".docx"))
Get the color scheme of a 'PowerPoint' master layout into a data.frame.
color_scheme(x)
color_scheme(x)
x |
an rpptx object |
Other functions for reading presentation information:
annotate_base()
,
doc_properties()
,
layout_properties()
,
layout_summary()
,
length.rpptx()
,
plot_layout_properties()
,
slide_size()
,
slide_summary()
x <- read_pptx() color_scheme ( x = x )
x <- read_pptx() color_scheme ( x = x )
A set of functions is available to manipulate the position of a virtual cursor. This cursor will be used when inserting, deleting or updating elements in the document.
cursor_begin(x) cursor_bookmark(x, id) cursor_end(x) cursor_reach(x, keyword, fixed = FALSE) cursor_reach_test(x, keyword) cursor_forward(x) cursor_backward(x)
cursor_begin(x) cursor_bookmark(x, id) cursor_end(x) cursor_reach(x, keyword, fixed = FALSE) cursor_reach_test(x, keyword) cursor_forward(x) cursor_backward(x)
x |
a docx device |
id |
bookmark id |
keyword |
keyword to look for as a regular expression |
fixed |
logical. If TRUE, pattern is a string to be matched as is. |
Set the cursor at the beginning of the document, on the first element of the document (usually a paragraph or a table).
Set the cursor at a bookmark that has previously been set.
Set the cursor at the end of the document, on the last element of the document.
Set the cursor on the first element of the document
that contains text specified in argument keyword
.
The argument keyword
is a regexpr pattern.
Test if an expression has a match in the document
that contains text specified in argument keyword
.
The argument keyword
is a regexpr pattern.
Move the cursor forward, it increments the cursor in the document.
Move the cursor backward, it decrements the cursor in the document.
library(officer) # create a template ---- doc <- read_docx() doc <- body_add_par(doc, "blah blah blah") doc <- body_add_par(doc, "blah blah blah") doc <- body_add_par(doc, "blah blah blah") doc <- body_add_par(doc, "Hello text to replace") doc <- body_add_par(doc, "blah blah blah") doc <- body_add_par(doc, "blah blah blah") doc <- body_add_par(doc, "blah blah blah") doc <- body_add_par(doc, "Hello text to replace") doc <- body_add_par(doc, "blah blah blah") template_file <- print( x = doc, target = tempfile(fileext = ".docx") ) # replace all pars containing "to replace" ---- doc <- read_docx(path = template_file) while (cursor_reach_test(doc, "to replace")) { doc <- cursor_reach(doc, "to replace") doc <- body_add_fpar( x = doc, pos = "on", value = fpar( "Here is a link: ", hyperlink_ftext( text = "yopyop", href = "https://cran.r-project.org/" ) ) ) } doc <- cursor_end(doc) doc <- body_add_par(doc, "Yap yap yap yap...") result_file <- print( x = doc, target = tempfile(fileext = ".docx") ) # cursor_bookmark ---- doc <- read_docx() doc <- body_add_par(doc, "centered text", style = "centered") doc <- body_bookmark(doc, "text_to_replace") doc <- body_add_par(doc, "A title", style = "heading 1") doc <- body_add_par(doc, "Hello world!", style = "Normal") doc <- cursor_bookmark(doc, "text_to_replace") doc <- body_add_table(doc, value = iris, style = "table_template") print(doc, target = tempfile(fileext = ".docx"))
library(officer) # create a template ---- doc <- read_docx() doc <- body_add_par(doc, "blah blah blah") doc <- body_add_par(doc, "blah blah blah") doc <- body_add_par(doc, "blah blah blah") doc <- body_add_par(doc, "Hello text to replace") doc <- body_add_par(doc, "blah blah blah") doc <- body_add_par(doc, "blah blah blah") doc <- body_add_par(doc, "blah blah blah") doc <- body_add_par(doc, "Hello text to replace") doc <- body_add_par(doc, "blah blah blah") template_file <- print( x = doc, target = tempfile(fileext = ".docx") ) # replace all pars containing "to replace" ---- doc <- read_docx(path = template_file) while (cursor_reach_test(doc, "to replace")) { doc <- cursor_reach(doc, "to replace") doc <- body_add_fpar( x = doc, pos = "on", value = fpar( "Here is a link: ", hyperlink_ftext( text = "yopyop", href = "https://cran.r-project.org/" ) ) ) } doc <- cursor_end(doc) doc <- body_add_par(doc, "Yap yap yap yap...") result_file <- print( x = doc, target = tempfile(fileext = ".docx") ) # cursor_bookmark ---- doc <- read_docx() doc <- body_add_par(doc, "centered text", style = "centered") doc <- body_bookmark(doc, "text_to_replace") doc <- body_add_par(doc, "A title", style = "heading 1") doc <- body_add_par(doc, "Hello world!", style = "Normal") doc <- cursor_bookmark(doc, "text_to_replace") doc <- body_add_table(doc, value = iris, style = "table_template") print(doc, target = tempfile(fileext = ".docx"))
Read Word or PowerPoint document properties and get results in a data.frame.
doc_properties(x)
doc_properties(x)
x |
an |
a data.frame
Other functions for Word document informations:
docx_bookmarks()
,
docx_dim()
,
length.rdocx()
,
set_doc_properties()
,
styles_info()
Other functions for reading presentation information:
annotate_base()
,
color_scheme()
,
layout_properties()
,
layout_summary()
,
length.rpptx()
,
plot_layout_properties()
,
slide_size()
,
slide_summary()
x <- read_docx() doc_properties(x)
x <- read_docx() doc_properties(x)
List bookmarks id that can be found in a 'Word' document.
docx_bookmarks(x)
docx_bookmarks(x)
x |
an |
Other functions for Word document informations:
doc_properties()
,
docx_dim()
,
length.rdocx()
,
set_doc_properties()
,
styles_info()
library(officer) doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, "centered text", style = "centered") doc_1 <- body_bookmark(doc_1, "text_to_replace_1") doc_1 <- body_add_par(doc_1, "centered text", style = "centered") doc_1 <- body_bookmark(doc_1, "text_to_replace_2") docx_bookmarks(doc_1) docx_bookmarks(read_docx())
library(officer) doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, "centered text", style = "centered") doc_1 <- body_bookmark(doc_1, "text_to_replace_1") doc_1 <- body_add_par(doc_1, "centered text", style = "centered") doc_1 <- body_bookmark(doc_1, "text_to_replace_2") docx_bookmarks(doc_1) docx_bookmarks(read_docx())
return a data.frame representing the comments in a Word document.
docx_comments(x)
docx_comments(x)
x |
an rdocx object |
Each row of the returned data frame contains data for one comment. The columns contain the following information:
"comment_id" - unique comment id
"author" - name of the comment author
"initials" - initials of the comment author
"date" - timestamp of the comment
"text" - a list column of characters containing the comment text. Elements can be vectors of length > 1 if a comment contains multiple paragraphs, blocks or runs or of length 0 if the comment is empty.
"para_id" - a list column of characters containing the parent paragraph IDs. Elememts can be vectors of length > 1 if a comment spans multiple paragraphs or of length 0 if the comment has no parent paragraph.
"commented_text" - a list column of characters containing the commented text. Elememts can be vectors of length > 1 if a comment spans multiple paragraphs or runs or of length 0 if the commented text is empty.
bl <- block_list( fpar("Comment multiple words."), fpar("Second line") ) a_par <- fpar( "This paragraph contains", run_comment( cmt = bl, run = ftext("a comment."), author = "Author Me", date = "2023-06-01" ) ) doc <- read_docx() doc <- body_add_fpar(doc, value = a_par, style = "Normal") docx_file <- print(doc, target = tempfile(fileext = ".docx")) docx_comments(read_docx(docx_file))
bl <- block_list( fpar("Comment multiple words."), fpar("Second line") ) a_par <- fpar( "This paragraph contains", run_comment( cmt = bl, run = ftext("a comment."), author = "Author Me", date = "2023-06-01" ) ) doc <- read_docx() doc <- body_add_fpar(doc, value = a_par, style = "Normal") docx_file <- print(doc, target = tempfile(fileext = ".docx")) docx_comments(read_docx(docx_file))
Get page width, page height and margins (in inches). The return values are those corresponding to the section where the cursor is.
docx_dim(x)
docx_dim(x)
x |
an |
Other functions for Word document informations:
doc_properties()
,
docx_bookmarks()
,
length.rdocx()
,
set_doc_properties()
,
styles_info()
docx_dim(read_docx())
docx_dim(read_docx())
The function lets you add or modify Word character styles.
docx_set_character_style( x, style_id, style_name, base_on, fp_t = fp_text_lite() )
docx_set_character_style( x, style_id, style_name, base_on, fp_t = fp_text_lite() )
x |
an rdocx object |
style_id |
a unique style identifier for Word. |
style_name |
a unique label associated with the style identifier. This label is the name of the style when Word edit the document. |
base_on |
the character style name used as base style |
fp_t |
Text formatting properties, see |
library(officer) doc <- read_docx() doc <- docx_set_character_style( doc, style_id = "newcharstyle", style_name = "label for char style", base_on = "Default Paragraph Font", fp_text_lite( shading.color = "red", color = "white") ) paragraph <- fpar( run_wordtext("hello", style_id = "newcharstyle")) doc <- body_add_fpar(doc, value = paragraph) docx_file <- print(doc, target = tempfile(fileext = ".docx")) docx_file
library(officer) doc <- read_docx() doc <- docx_set_character_style( doc, style_id = "newcharstyle", style_name = "label for char style", base_on = "Default Paragraph Font", fp_text_lite( shading.color = "red", color = "white") ) paragraph <- fpar( run_wordtext("hello", style_id = "newcharstyle")) doc <- body_add_fpar(doc, value = paragraph) docx_file <- print(doc, target = tempfile(fileext = ".docx")) docx_file
The function lets you add or replace a Word paragraph style.
docx_set_paragraph_style( x, style_id, style_name, base_on = "Normal", fp_p = fp_par(), fp_t = NULL )
docx_set_paragraph_style( x, style_id, style_name, base_on = "Normal", fp_p = fp_par(), fp_t = NULL )
x |
an rdocx object |
style_id |
a unique style identifier for Word. |
style_name |
a unique label associated with the style identifier. This label is the name of the style when Word edit the document. |
base_on |
the style name used as base style |
fp_p |
paragraph formatting properties, see |
fp_t |
default text formatting properties. This is used as
text formatting properties, see |
library(officer) doc <- read_docx() doc <- docx_set_paragraph_style( doc, style_id = "rightaligned", style_name = "Explicit label", fp_p = fp_par(text.align = "right", padding = 20), fp_t = fp_text_lite( bold = TRUE, shading.color = "#FD34F0", color = "white") ) doc <- body_add_par(doc, value = "This is a test", style = "Explicit label") docx_file <- print(doc, target = tempfile(fileext = ".docx")) docx_file
library(officer) doc <- read_docx() doc <- docx_set_paragraph_style( doc, style_id = "rightaligned", style_name = "Explicit label", fp_p = fp_par(text.align = "right", padding = 20), fp_t = fp_text_lite( bold = TRUE, shading.color = "#FD34F0", color = "white") ) doc <- body_add_par(doc, value = "This is a test", style = "Explicit label") docx_file <- print(doc, target = tempfile(fileext = ".docx")) docx_file
Show the structure of text tags at the current cursor. This is
most useful when trying to troubleshoot search-and-replace functionality
using body_replace_all_text
.
docx_show_chunk(x)
docx_show_chunk(x)
x |
a docx device |
doc <- read_docx() doc <- body_add_par(doc, "Placeholder one") doc <- body_add_par(doc, "Placeholder two") # Show text chunk at cursor docx_show_chunk(doc) # Output is 'Placeholder two'
doc <- read_docx() doc <- body_add_par(doc, "Placeholder one") doc <- body_add_par(doc, "Placeholder two") # Show text chunk at cursor docx_show_chunk(doc) # Output is 'Placeholder two'
read content of a Word document and return a data.frame representing the document.
docx_summary(x, preserve = FALSE, remove_fields = FALSE, detailed = FALSE)
docx_summary(x, preserve = FALSE, remove_fields = FALSE, detailed = FALSE)
x |
an rdocx object |
preserve |
If |
remove_fields |
if TRUE, prevent field codes from appearing in the returned data.frame. |
detailed |
Should information on runs be included in summary dataframe?
Defaults to |
Documents included with body_add_docx()
will
not be accessible in the results.
example_docx <- system.file( package = "officer", "doc_examples/example.docx" ) doc <- read_docx(example_docx) docx_summary(doc) docx_summary(doc, preserve = TRUE)[28, ]
example_docx <- system.file( package = "officer", "doc_examples/example.docx" ) doc <- read_docx(example_docx) docx_summary(doc) docx_summary(doc, preserve = TRUE)[28, ]
Create an empty object to include as an empty placeholder shape in a presentation. This comes in handy when presentation are updated through R, but a user still wants to add some comments in this new content.
Empty content also works with layout fields (slide number and date) to preserve them: they are included on the slide and keep being updated by PowerPoint, i.e. update to the when the slide number when the slide moves in the deck, update to the date.
empty_content()
empty_content()
fileout <- tempfile(fileext = ".pptx") doc <- read_pptx() doc <- add_slide(doc, layout = "Two Content", master = "Office Theme") doc <- ph_with(x = doc, value = empty_content(), location = ph_location_type(type = "title") ) doc <- add_slide(doc) # add slide number as a computer field doc <- ph_with( x = doc, value = empty_content(), location = ph_location_type(type = "sldNum")) print(doc, target = fileout )
fileout <- tempfile(fileext = ".pptx") doc <- read_pptx() doc <- add_slide(doc, layout = "Two Content", master = "Office Theme") doc <- ph_with(x = doc, value = empty_content(), location = ph_location_type(type = "title") ) doc <- add_slide(doc) # add slide number as a computer field doc <- ph_with( x = doc, value = empty_content(), location = ph_location_type(type = "sldNum")) print(doc, target = fileout )
Wraps an image in an object that can then be embedded in a PowerPoint slide or within a Word paragraph.
The image is added as a shape in PowerPoint (it is not possible to mix text and images in a PowerPoint form). With a Word document, the image will be added inside a paragraph.
external_img( src, width = 0.5, height = 0.2, unit = "in", guess_size = FALSE, alt = "" )
external_img( src, width = 0.5, height = 0.2, unit = "in", guess_size = FALSE, alt = "" )
src |
image file path |
width , height
|
size of the image file. It can be ignored
if parameter |
unit |
unit for width and height, one of "in", "cm", "mm". |
guess_size |
If package 'magick' is installed, this option
can be used (set it to |
alt |
alternative text for images |
You can use this function in conjunction with fpar to create paragraphs consisting of differently formatted text parts. You can also use this function as an r chunk in an R Markdown document made with package officedown.
Other run functions for reporting:
ftext()
,
hyperlink_ftext()
,
run_autonum()
,
run_bookmark()
,
run_columnbreak()
,
run_comment()
,
run_footnote()
,
run_footnoteref()
,
run_linebreak()
,
run_pagebreak()
,
run_reference()
,
run_tab()
,
run_word_field()
,
run_wordtext()
# wrap r logo with external_img ---- srcfile <- file.path(R.home("doc"), "html", "logo.jpg") extimg <- external_img( src = srcfile, height = 1.06 / 2, width = 1.39 / 2 ) # pptx example ---- doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with( x = doc, value = extimg, location = ph_location_type(type = "body"), use_loc_size = FALSE ) print(doc, target = tempfile(fileext = ".pptx")) fp_t <- fp_text(font.size = 20, color = "red") an_fpar <- fpar(extimg, ftext(" is cool!", fp_t)) # docx example ---- x <- read_docx() x <- body_add(x, an_fpar) print(x, target = tempfile(fileext = ".docx"))
# wrap r logo with external_img ---- srcfile <- file.path(R.home("doc"), "html", "logo.jpg") extimg <- external_img( src = srcfile, height = 1.06 / 2, width = 1.39 / 2 ) # pptx example ---- doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with( x = doc, value = extimg, location = ph_location_type(type = "body"), use_loc_size = FALSE ) print(doc, target = tempfile(fileext = ".pptx")) fp_t <- fp_text(font.size = 20, color = "red") an_fpar <- fpar(extimg, ftext(" is cool!", fp_t)) # docx example ---- x <- read_docx() x <- body_add(x, an_fpar) print(x, target = tempfile(fileext = ".docx"))
create a border properties object.
fp_border(color = "black", style = "solid", width = 1) ## S3 method for class 'fp_border' update(object, color, style, width, ...)
fp_border(color = "black", style = "solid", width = 1) ## S3 method for class 'fp_border' update(object, color, style, width, ...)
color |
border color - single character value (e.g. "#000000" or "black") |
style |
border style - single character value : See Details for supported border styles. |
width |
border width - an integer value : 0>= value |
object |
fp_border object |
... |
further arguments - not used |
For Word output the following border styles are supported:
"none" or "nil" - No Border
"solid" or "single" - Single Line Border
"thick" - Single Line Border
"double" - Double Line Border
"dotted" - Dotted Line Border
"dashed" - Dashed Line Border
"dotDash" - Dot Dash Line Border
"dotDotDash" - Dot Dot Dash Line Border
"triple" - Triple Line Border
"thinThickSmallGap" - Thin, Thick Line Border
"thickThinSmallGap" - Thick, Thin Line Border
"thinThickThinSmallGap" - Thin, Thick, Thin Line Border
"thinThickMediumGap" - Thin, Thick Line Border
"thickThinMediumGap" - Thick, Thin Line Border
"thinThickThinMediumGap" - Thin, Thick, Thin Line Border
"thinThickLargeGap" - Thin, Thick Line Border
"thickThinLargeGap" - Thick, Thin Line Border
"thinThickThinLargeGap" - Thin, Thick, Thin Line Border
"wave" - Wavy Line Border
"doubleWave" - Double Wave Line Border
"dashSmallGap" - Dashed Line Border
"dashDotStroked" - Dash Dot Strokes Line Border
"threeDEmboss" or "ridge" - 3D Embossed Line Border
"threeDEngrave" or "groove" - 3D Engraved Line Border
"outset" - Outset Line Border
"inset" - Inset Line Border
For HTML output only a limited amount of border styles are supported:
"none" or "nil" - No Border
"solid" or "single" - Single Line Border
"double" - Double Line Border
"dotted" - Dotted Line Border
"dashed" - Dashed Line Border
"threeDEmboss" or "ridge" - 3D Embossed Line Border
"threeDEngrave" or "groove" - 3D Engraved Line Border
"outset" - Outset Line Border
"inset" - Inset Line Border
Non-supported Word border styles will default to "solid".
Other functions for defining formatting properties:
fp_cell()
,
fp_par()
,
fp_tab()
,
fp_tabs()
,
fp_text()
fp_border() fp_border(color = "orange", style = "solid", width = 1) fp_border(color = "gray", style = "dotted", width = 1) # modify object ------ border <- fp_border() update(border, style = "dotted", width = 3)
fp_border() fp_border(color = "orange", style = "solid", width = 1) fp_border(color = "gray", style = "dotted", width = 1) # modify object ------ border <- fp_border() update(border, style = "dotted", width = 3)
Create a fp_cell
object that describes cell formatting properties.
fp_cell( border = fp_border(width = 0), border.bottom, border.left, border.top, border.right, vertical.align = "center", margin = 0, margin.bottom, margin.top, margin.left, margin.right, background.color = "transparent", text.direction = "lrtb", rowspan = 1, colspan = 1 ) ## S3 method for class 'fp_cell' format(x, type = "wml", ...) ## S3 method for class 'fp_cell' print(x, ...) ## S3 method for class 'fp_cell' update( object, border, border.bottom, border.left, border.top, border.right, vertical.align, margin = 0, margin.bottom, margin.top, margin.left, margin.right, background.color, text.direction, rowspan = 1, colspan = 1, ... )
fp_cell( border = fp_border(width = 0), border.bottom, border.left, border.top, border.right, vertical.align = "center", margin = 0, margin.bottom, margin.top, margin.left, margin.right, background.color = "transparent", text.direction = "lrtb", rowspan = 1, colspan = 1 ) ## S3 method for class 'fp_cell' format(x, type = "wml", ...) ## S3 method for class 'fp_cell' print(x, ...) ## S3 method for class 'fp_cell' update( object, border, border.bottom, border.left, border.top, border.right, vertical.align, margin = 0, margin.bottom, margin.top, margin.left, margin.right, background.color, text.direction, rowspan = 1, colspan = 1, ... )
border |
shortcut for all borders. |
border.bottom , border.left , border.top , border.right
|
|
vertical.align |
cell content vertical alignment - a single character value, expected value is one of "center" or "top" or "bottom" |
margin |
shortcut for all margins. |
margin.bottom , margin.top , margin.left , margin.right
|
cell margins - 0 or positive integer value. |
background.color |
cell background color - a single character value specifying a valid color (e.g. "#000000" or "black"). |
text.direction |
cell text rotation - a single character value, expected value is one of "lrtb", "tbrl", "btlr". |
rowspan |
specify how many rows the cell is spanned over |
colspan |
specify how many columns the cell is spanned over |
x , object
|
|
type |
output type - one of 'wml', 'pml', 'html', 'rtf'. |
... |
further arguments - not used |
Other functions for defining formatting properties:
fp_border()
,
fp_par()
,
fp_tab()
,
fp_tabs()
,
fp_text()
obj <- fp_cell(margin = 1) update(obj, margin.bottom = 5)
obj <- fp_cell(margin = 1) update(obj, margin.bottom = 5)
Create a fp_par
object that describes
paragraph formatting properties.
fp_par( text.align = "left", padding = 0, line_spacing = 1, border = fp_border(width = 0), padding.bottom, padding.top, padding.left, padding.right, border.bottom, border.left, border.top, border.right, shading.color = "transparent", keep_with_next = FALSE, tabs = NULL, word_style = "Normal" ) ## S3 method for class 'fp_par' print(x, ...) ## S3 method for class 'fp_par' update( object, text.align, padding, border, padding.bottom, padding.top, padding.left, padding.right, border.bottom, border.left, border.top, border.right, shading.color, keep_with_next, word_style, ... )
fp_par( text.align = "left", padding = 0, line_spacing = 1, border = fp_border(width = 0), padding.bottom, padding.top, padding.left, padding.right, border.bottom, border.left, border.top, border.right, shading.color = "transparent", keep_with_next = FALSE, tabs = NULL, word_style = "Normal" ) ## S3 method for class 'fp_par' print(x, ...) ## S3 method for class 'fp_par' update( object, text.align, padding, border, padding.bottom, padding.top, padding.left, padding.right, border.bottom, border.left, border.top, border.right, shading.color, keep_with_next, word_style, ... )
text.align |
text alignment - a single character value, expected value is one of 'left', 'right', 'center', 'justify'. |
padding |
paragraph paddings - 0 or positive integer value. Argument |
line_spacing |
line spacing, 1 is single line spacing, 2 is double line spacing. |
border |
shortcut for all borders. |
padding.bottom , padding.top , padding.left , padding.right
|
paragraph paddings - 0 or positive integer value. |
border.bottom , border.left , border.top , border.right
|
|
shading.color |
shading color - a single character value specifying a valid color (e.g. "#000000" or "black"). |
keep_with_next |
a scalar logical. Specifies that the paragraph (or at least part of it) should be rendered on the same page as the next paragraph when possible. |
tabs |
NULL (default) for no tabulation marks setting
or an object returned by |
word_style |
Word paragraph style name |
x , object
|
|
... |
further arguments - not used |
a fp_par
object
Other functions for defining formatting properties:
fp_border()
,
fp_cell()
,
fp_tab()
,
fp_tabs()
,
fp_text()
fp_par(text.align = "center", padding = 5) obj <- fp_par(text.align = "center", padding = 1) update(obj, padding.bottom = 5)
fp_par(text.align = "center", padding = 5) obj <- fp_par(text.align = "center", padding = 1) update(obj, padding.bottom = 5)
create a tabulation mark properties setting object for Word
or RTF. Results can be used as arguments of fp_tabs()
.
Once tabulation marks settings are defined, tabulation marks can
be added with run_tab()
inside a call to fpar()
or
with \t
within 'flextable' content.
fp_tab(pos, style = "decimal")
fp_tab(pos, style = "decimal")
pos |
Specifies the position of the tab stop (in inches). |
style |
style of the tab. Possible values are: "decimal", "left", "right" or "center". |
Other functions for defining formatting properties:
fp_border()
,
fp_cell()
,
fp_par()
,
fp_tabs()
,
fp_text()
fp_tab(pos = 0.4, style = "decimal") fp_tab(pos = 1, style = "right")
fp_tab(pos = 0.4, style = "decimal") fp_tab(pos = 1, style = "right")
create a set of tabulation mark properties object for Word or RTF.
Results can be used as arguments tabs
of fp_par()
and will only have
effects in Word or RTF outputs.
Once a set of tabulation marks settings is defined, tabulation marks can
be added with run_tab()
inside a call to fpar()
or
with \t
within 'flextable' content.
fp_tabs(...)
fp_tabs(...)
... |
fp_tab objects |
Other functions for defining formatting properties:
fp_border()
,
fp_cell()
,
fp_par()
,
fp_tab()
,
fp_text()
z <- fp_tabs( fp_tab(pos = 0.4, style = "decimal"), fp_tab(pos = 1, style = "decimal") ) fpar( run_tab(), ftext("88."), run_tab(), ftext("987.45"), fp_p = fp_par( tabs = z ) )
z <- fp_tabs( fp_tab(pos = 0.4, style = "decimal"), fp_tab(pos = 1, style = "decimal") ) fpar( run_tab(), ftext("88."), run_tab(), ftext("987.45"), fp_p = fp_par( tabs = z ) )
Create a fp_text
object that describes
text formatting properties.
Function fp_text_lite()
is generating properties
with only entries for the parameters users provided. The
undefined properties will inherit from the default settings.
fp_text( color = "black", font.size = 10, bold = FALSE, italic = FALSE, underlined = FALSE, font.family = "Arial", cs.family = NULL, eastasia.family = NULL, hansi.family = NULL, vertical.align = "baseline", shading.color = "transparent" ) fp_text_lite( color = NA, font.size = NA, font.family = NA, cs.family = NA, eastasia.family = NA, hansi.family = NA, bold = NA, italic = NA, underlined = NA, vertical.align = "baseline", shading.color = NA ) ## S3 method for class 'fp_text' format(x, type = "wml", ...) ## S3 method for class 'fp_text' print(x, ...) ## S3 method for class 'fp_text' update( object, color, font.size, bold, italic, underlined, font.family, cs.family, eastasia.family, hansi.family, vertical.align, shading.color, ... )
fp_text( color = "black", font.size = 10, bold = FALSE, italic = FALSE, underlined = FALSE, font.family = "Arial", cs.family = NULL, eastasia.family = NULL, hansi.family = NULL, vertical.align = "baseline", shading.color = "transparent" ) fp_text_lite( color = NA, font.size = NA, font.family = NA, cs.family = NA, eastasia.family = NA, hansi.family = NA, bold = NA, italic = NA, underlined = NA, vertical.align = "baseline", shading.color = NA ) ## S3 method for class 'fp_text' format(x, type = "wml", ...) ## S3 method for class 'fp_text' print(x, ...) ## S3 method for class 'fp_text' update( object, color, font.size, bold, italic, underlined, font.family, cs.family, eastasia.family, hansi.family, vertical.align, shading.color, ... )
color |
font color - a single character value specifying a valid color (e.g. "#000000" or "black"). |
font.size |
font size (in point) - 0 or positive integer value. |
bold |
is bold |
italic |
is italic |
underlined |
is underlined |
font.family |
single character value. Specifies the font to be used to format characters in the Unicode range (U+0000-U+007F). |
cs.family |
optional font to be used to format characters in a complex script Unicode range. For example, Arabic text might be displayed using the "Arial Unicode MS" font. |
eastasia.family |
optional font to be used to format characters in an East Asian Unicode range. For example, Japanese text might be displayed using the "MS Mincho" font. |
hansi.family |
optional. Specifies the font to be used to format characters in a Unicode range which does not fall into one of the other categories. |
vertical.align |
single character value specifying font vertical alignments.
Expected value is one of the following : default |
shading.color |
shading color - a single character value specifying a valid color (e.g. "#000000" or "black"). |
x |
|
type |
output type - one of 'wml', 'pml', 'html', 'rtf'. |
... |
further arguments - not used |
object |
|
format |
format type, wml for MS word, pml for MS PowerPoint and html. |
a fp_text
object
Other functions for defining formatting properties:
fp_border()
,
fp_cell()
,
fp_par()
,
fp_tab()
,
fp_tabs()
fp_text() fp_text(color = "red") fp_text(bold = TRUE, shading.color = "yellow") print(fp_text(color = "red", font.size = 12))
fp_text() fp_text(color = "red") fp_text(bold = TRUE, shading.color = "yellow") print(fp_text(color = "red", font.size = 12))
Create a paragraph representation by concatenating
formatted text or images. The result can be inserted in a Word document
or a PowerPoint presentation and can also be inserted in a block_list()
call.
All its arguments will be concatenated to create a paragraph where chunks of text and images are associated with formatting properties.
fpar
supports ftext()
, external_img()
, run_*
functions
(i.e. run_autonum()
, run_word_field()
) when output is Word, and simple strings.
Default text and paragraph formatting properties can also be modified
with function update()
.
fpar(..., fp_p = fp_par(), fp_t = fp_text_lite(), values = NULL) ## S3 method for class 'fpar' update(object, fp_p = NULL, fp_t = NULL, ...)
fpar(..., fp_p = fp_par(), fp_t = fp_text_lite(), values = NULL) ## S3 method for class 'fpar' update(object, fp_p = NULL, fp_t = NULL, ...)
... |
cot objects ( |
fp_p |
paragraph formatting properties, see |
fp_t |
default text formatting properties. This is used as
text formatting properties when simple text is provided as argument,
see |
values |
a list of cot objects. If provided, argument |
object |
fpar object |
block_list()
, body_add_fpar()
, ph_with()
Other block functions for reporting:
block_caption()
,
block_list()
,
block_pour_docx()
,
block_section()
,
block_table()
,
block_toc()
,
plot_instr()
,
unordered_list()
fpar(ftext("hello", shortcuts$fp_bold())) # mix text and image ----- img.file <- file.path( R.home("doc"), "html", "logo.jpg" ) bold_face <- shortcuts$fp_bold(font.size = 12) bold_redface <- update(bold_face, color = "red") fpar_1 <- fpar( "Hello World, ", ftext("how ", prop = bold_redface ), external_img(src = img.file, height = 1.06/2, width = 1.39/2), ftext(" you?", prop = bold_face ) ) fpar_1 img_in_par <- fpar( external_img(src = img.file, height = 1.06/2, width = 1.39/2), fp_p = fp_par(text.align = "center") )
fpar(ftext("hello", shortcuts$fp_bold())) # mix text and image ----- img.file <- file.path( R.home("doc"), "html", "logo.jpg" ) bold_face <- shortcuts$fp_bold(font.size = 12) bold_redface <- update(bold_face, color = "red") fpar_1 <- fpar( "Hello World, ", ftext("how ", prop = bold_redface ), external_img(src = img.file, height = 1.06/2, width = 1.39/2), ftext(" you?", prop = bold_face ) ) fpar_1 img_in_par <- fpar( external_img(src = img.file, height = 1.06/2, width = 1.39/2), fp_p = fp_par(text.align = "center") )
Format a chunk of text with text formatting properties (bold, color, ...). The function allows you to create pieces of text formatted the way you want.
ftext(text, prop = NULL)
ftext(text, prop = NULL)
text |
text value, a single character value |
prop |
formatting text properties returned by fp_text. It also can be NULL in which case, no formatting is defined (the default is applied). |
You can use this function in conjunction with fpar to create paragraphs consisting of differently formatted text parts. You can also use this function as an r chunk in an R Markdown document made with package officedown.
Other run functions for reporting:
external_img()
,
hyperlink_ftext()
,
run_autonum()
,
run_bookmark()
,
run_columnbreak()
,
run_comment()
,
run_footnote()
,
run_footnoteref()
,
run_linebreak()
,
run_pagebreak()
,
run_reference()
,
run_tab()
,
run_word_field()
,
run_wordtext()
ftext("hello", fp_text()) properties1 <- fp_text(color = "red") properties2 <- fp_text(bold = TRUE, shading.color = "yellow") ftext1 <- ftext("hello", properties1) ftext2 <- ftext("World", properties2) paragraph <- fpar(ftext1, " ", ftext2) x <- read_docx() x <- body_add(x, paragraph) print(x, target = tempfile(fileext = ".docx"))
ftext("hello", fp_text()) properties1 <- fp_text(color = "red") properties2 <- fp_text(bold = TRUE, shading.color = "yellow") ftext1 <- ftext("hello", properties1) ftext2 <- ftext("World", properties2) paragraph <- fpar(ftext1, " ", ftext2) x <- read_docx() x <- body_add(x, paragraph) print(x, target = tempfile(fileext = ".docx"))
Format a chunk of text with text formatting properties (bold, color, ...), the chunk is associated with an hyperlink.
hyperlink_ftext(text, prop = NULL, href)
hyperlink_ftext(text, prop = NULL, href)
text |
text value, a single character value |
prop |
formatting text properties returned by fp_text. It also can be NULL in which case, no formatting is defined (the default is applied). |
href |
URL value |
You can use this function in conjunction with fpar to create paragraphs consisting of differently formatted text parts. You can also use this function as an r chunk in an R Markdown document made with package officedown.
Other run functions for reporting:
external_img()
,
ftext()
,
run_autonum()
,
run_bookmark()
,
run_columnbreak()
,
run_comment()
,
run_footnote()
,
run_footnoteref()
,
run_linebreak()
,
run_pagebreak()
,
run_reference()
,
run_tab()
,
run_word_field()
,
run_wordtext()
ft <- fp_text(font.size = 12, bold = TRUE) hyperlink_ftext( href = "https://cran.r-project.org/index.html", text = "some text", prop = ft )
ft <- fp_text(font.size = 12, bold = TRUE) hyperlink_ftext( href = "https://cran.r-project.org/index.html", text = "some text", prop = ft )
PowerPoint does not enforce unique placeholder labels in a layout. Selecting a placeholder via its label using ph_location_label will throw an error, if the label is not unique. layout_dedupe_ph_labels helps to detect, rename, or delete duplicate placholder labels.
layout_dedupe_ph_labels(x, action = "detect", print_info = FALSE)
layout_dedupe_ph_labels(x, action = "detect", print_info = FALSE)
x |
An |
action |
Action to perform on duplicate placeholder labels. One of:
|
print_info |
Print action information (e.g. renamed placeholders) to console?
Default is |
A rpptx
object (with modified placeholder labels).
x <- read_pptx() layout_dedupe_ph_labels(x) file <- system.file("doc_examples", "ph_dupes.pptx", package = "officer") x <- read_pptx(file) layout_dedupe_ph_labels(x) layout_dedupe_ph_labels(x, "rename", print_info = TRUE)
x <- read_pptx() layout_dedupe_ph_labels(x) file <- system.file("doc_examples", "ph_dupes.pptx", package = "officer") x <- read_pptx(file) layout_dedupe_ph_labels(x) layout_dedupe_ph_labels(x, "rename", print_info = TRUE)
Detailed information about the placeholders on the slide layouts (label, position, etc.). See Value section below for more info.
layout_properties(x, layout = NULL, master = NULL)
layout_properties(x, layout = NULL, master = NULL)
x |
an |
layout |
slide layout name. If |
master |
master layout name where |
Returns a data frame with one row per placeholder and the following columns:
master_name
: Name of master (a .pptx
file may have more than one)
name
: Name of layout
type
: Placeholder type
type_idx
: Running index for phs of the same type. Ordering by ph position
(top -> bottom, left -> right)
id
: A unique placeholder id (assigned by PowerPoint automatically, starts at 2, potentially non-consecutive)
ph_label
: Placeholder label (can be set by the user in PowerPoint)
ph
: Placholder XML fragment (usually not needed)
offx
,offy
: placeholder's distance from left and top edge (in inch)
cx
,cy
: width and height of placeholder (in inch)
rotation
: rotation in degrees
fld_id
is generally stored as a hexadecimal or GUID value
fld_type
: a unique identifier for a particular field
Other functions for reading presentation information:
annotate_base()
,
color_scheme()
,
doc_properties()
,
layout_summary()
,
length.rpptx()
,
plot_layout_properties()
,
slide_size()
,
slide_summary()
x <- read_pptx() layout_properties(x = x, layout = "Title Slide", master = "Office Theme") layout_properties(x = x, master = "Office Theme") layout_properties(x = x, layout = "Two Content") layout_properties(x = x)
x <- read_pptx() layout_properties(x = x, layout = "Title Slide", master = "Office Theme") layout_properties(x = x, master = "Office Theme") layout_properties(x = x, layout = "Two Content") layout_properties(x = x)
There are two versions of the function. The first takes a set of key-value pairs to rename the
ph labels. The second uses a right hand side (rhs) assignment to specify the new ph labels.
See section Details.
NB: You can also rename ph labels directly in PowerPoint. Open the master template view
(Alt
+ F10
) and go to Home
> Arrange
> Selection Pane
.
layout_rename_ph_labels(x, layout, master = NULL, ..., .dots = NULL) layout_rename_ph_labels(x, layout, master = NULL, id = NULL) <- value
layout_rename_ph_labels(x, layout, master = NULL, ..., .dots = NULL) layout_rename_ph_labels(x, layout, master = NULL, id = NULL) <- value
x |
An |
layout |
Layout name or index. Index is the row index of |
master |
Name of master. Only required if the layout name is not unique across masters. |
... |
Comma separated list of key-value pairs to rename phs. Either reference a ph via its label
( |
.dots |
Provide a named list or vector of key-value pairs to rename phs
( |
id |
Unique placeholder id (see column |
value |
Not relevant for user. A pure technical necessity for rhs assignments. |
Note the difference between the terms id
and index
. Both can be found in the output of
layout_properties()
. The unique ph id
is found in column id
. The index
refers to the
index of the data frame row.
In a right hand side (rhs) label assignment (<- new_labels
), there are two ways to
optionally specify a subset of phs to rename. In both cases, the length of the rhs vector
(the new labels) must match the length of the id or index:
use the id
argument to specify ph ids to rename: layout_rename_ph_labels(..., id = 2:3) <- new_labels
use an index
in squared brackets: layout_rename_ph_labels(...)[1:2] <- new_labels
Vector of renamed ph labels.
x <- read_pptx() # INFO ------------- # Returns layout's ph_labels by default in same order as layout_properties() layout_rename_ph_labels(x, "Comparison") layout_properties(x, "Comparison")$ph_label # BASICS ----------- # # HINT: run `plot_layout_properties(x, "Comparison")` to see how labels change # rename using key-value pairs: 'old label' = 'new label' or 'id' = 'new label' layout_rename_ph_labels(x, "Comparison", "Title 1" = "LABEL MATCHED") # label matching layout_rename_ph_labels(x, "Comparison", "3" = "ID MATCHED") # id matching layout_rename_ph_labels(x, "Comparison", "Date Placeholder 6" = "DATE", "8" = "FOOTER") # label, id # rename using a named list and the .dots arg renames <- list("Content Placeholder 3" = "CONTENT_1", "6" = "CONTENT_2") layout_rename_ph_labels(x, "Comparison", .dots = renames) # rename via rhs assignment and optional index (not id!) layout_rename_ph_labels(x, "Comparison") <- LETTERS[1:8] layout_rename_ph_labels(x, "Comparison")[1:3] <- paste("CHANGED", 1:3) # rename via rhs assignment and ph id (not index) layout_rename_ph_labels(x, "Comparison", id = c(2, 4)) <- paste("ID =", c(2, 4)) # MORE ------------ # make all labels lower case labels <- layout_rename_ph_labels(x, "Comparison") layout_rename_ph_labels(x, "Comparison") <- tolower(labels) # rename all labels to type [type_idx] lp <- layout_properties(x, "Comparison") layout_rename_ph_labels(x, "Comparison") <- paste0(lp$type, " [", lp$type_idx, "]") # rename duplicated placeholders (see also `layout_dedupe_ph_labels()`) file <- system.file("doc_examples", "ph_dupes.pptx", package = "officer") x <- read_pptx(file) lp <- layout_properties(x, "2-dupes") idx <- which(lp$ph_label == "Content 7") # exists twice layout_rename_ph_labels(x, "2-dupes")[idx] <- paste("DUPLICATE", seq_along(idx)) # warning: in case of duped labels only the first occurrence is renamed x <- read_pptx(file) layout_rename_ph_labels(x, "2-dupes", "Content 7" = "new label")
x <- read_pptx() # INFO ------------- # Returns layout's ph_labels by default in same order as layout_properties() layout_rename_ph_labels(x, "Comparison") layout_properties(x, "Comparison")$ph_label # BASICS ----------- # # HINT: run `plot_layout_properties(x, "Comparison")` to see how labels change # rename using key-value pairs: 'old label' = 'new label' or 'id' = 'new label' layout_rename_ph_labels(x, "Comparison", "Title 1" = "LABEL MATCHED") # label matching layout_rename_ph_labels(x, "Comparison", "3" = "ID MATCHED") # id matching layout_rename_ph_labels(x, "Comparison", "Date Placeholder 6" = "DATE", "8" = "FOOTER") # label, id # rename using a named list and the .dots arg renames <- list("Content Placeholder 3" = "CONTENT_1", "6" = "CONTENT_2") layout_rename_ph_labels(x, "Comparison", .dots = renames) # rename via rhs assignment and optional index (not id!) layout_rename_ph_labels(x, "Comparison") <- LETTERS[1:8] layout_rename_ph_labels(x, "Comparison")[1:3] <- paste("CHANGED", 1:3) # rename via rhs assignment and ph id (not index) layout_rename_ph_labels(x, "Comparison", id = c(2, 4)) <- paste("ID =", c(2, 4)) # MORE ------------ # make all labels lower case labels <- layout_rename_ph_labels(x, "Comparison") layout_rename_ph_labels(x, "Comparison") <- tolower(labels) # rename all labels to type [type_idx] lp <- layout_properties(x, "Comparison") layout_rename_ph_labels(x, "Comparison") <- paste0(lp$type, " [", lp$type_idx, "]") # rename duplicated placeholders (see also `layout_dedupe_ph_labels()`) file <- system.file("doc_examples", "ph_dupes.pptx", package = "officer") x <- read_pptx(file) lp <- layout_properties(x, "2-dupes") idx <- which(lp$ph_label == "Content 7") # exists twice layout_rename_ph_labels(x, "2-dupes")[idx] <- paste("DUPLICATE", seq_along(idx)) # warning: in case of duped labels only the first occurrence is renamed x <- read_pptx(file) layout_rename_ph_labels(x, "2-dupes", "Content 7" = "new label")
Get information about slide layouts and master layouts into a data.frame. This function returns a data.frame containing all layout and master names.
layout_summary(x)
layout_summary(x)
x |
an rpptx object |
Other functions for reading presentation information:
annotate_base()
,
color_scheme()
,
doc_properties()
,
layout_properties()
,
length.rpptx()
,
plot_layout_properties()
,
slide_size()
,
slide_summary()
my_pres <- read_pptx() layout_summary ( x = my_pres )
my_pres <- read_pptx() layout_summary ( x = my_pres )
return the number of blocks inside an rdocx object. This number also include the default section definition of a Word document - default Word section is an uninvisible element.
## S3 method for class 'rdocx' length(x)
## S3 method for class 'rdocx' length(x)
x |
an rdocx object |
Other functions for Word document informations:
doc_properties()
,
docx_bookmarks()
,
docx_dim()
,
set_doc_properties()
,
styles_info()
# how many elements are there in an new document produced # with the default template. length( read_docx() )
# how many elements are there in an new document produced # with the default template. length( read_docx() )
Function length
will return the number of slides.
## S3 method for class 'rpptx' length(x)
## S3 method for class 'rpptx' length(x)
x |
an rpptx object |
Other functions for reading presentation information:
annotate_base()
,
color_scheme()
,
doc_properties()
,
layout_properties()
,
layout_summary()
,
plot_layout_properties()
,
slide_size()
,
slide_summary()
my_pres <- read_pptx() my_pres <- add_slide(my_pres) my_pres <- add_slide(my_pres) length(my_pres)
my_pres <- read_pptx() my_pres <- add_slide(my_pres) my_pres <- add_slide(my_pres) length(my_pres)
Extract files from a rpptx
object.
media_extract(x, path, target)
media_extract(x, path, target)
x |
an rpptx object |
path |
media path, should be a relative path |
target |
target file |
example_pptx <- system.file(package = "officer", "doc_examples/example.pptx") doc <- read_pptx(example_pptx) content <- pptx_summary(doc) image_row <- content[content$content_type %in% "image", ] media_file <- image_row$media_file png_file <- tempfile(fileext = ".png") media_extract(doc, path = media_file, target = png_file)
example_pptx <- system.file(package = "officer", "doc_examples/example.pptx") doc <- read_pptx(example_pptx) content <- pptx_summary(doc) image_row <- content[content$content_type %in% "image", ] media_file <- image_row$media_file png_file <- tempfile(fileext = ".png") media_extract(doc, path = media_file, target = png_file)
Move a slide in a pptx presentation.
move_slide(x, index = NULL, to)
move_slide(x, index = NULL, to)
x |
an rpptx object |
index |
slide index, default to current slide position. |
to |
new slide index. |
cursor is set on the last slide.
Other functions slide manipulation:
add_slide()
,
on_slide()
,
remove_slide()
,
set_notes()
x <- read_pptx() x <- add_slide(x) x <- ph_with(x, "Hello world 1", location = ph_location_type()) x <- add_slide(x) x <- ph_with(x, "Hello world 2", location = ph_location_type()) x <- move_slide(x, index = 1, to = 2)
x <- read_pptx() x <- add_slide(x) x <- ph_with(x, "Hello world 1", location = ph_location_type()) x <- add_slide(x) x <- ph_with(x, "Hello world 2", location = ph_location_type()) x <- move_slide(x, index = 1, to = 2)
The function will use the label of a placeholder to find the corresponding location in the slide notes.
notes_location_label(ph_label, ...)
notes_location_label(ph_label, ...)
ph_label |
placeholder label of the used notes master |
... |
unused arguments |
The function will use the type name of the placeholder (e.g. body, hdr), to find the corresponding location.
notes_location_type(type = "body", ...)
notes_location_type(type = "body", ...)
type |
placeholder label of the used notes master |
... |
unused arguments |
The officer package facilitates access to and manipulation of 'Microsoft Word' and 'Microsoft PowerPoint' documents from R. It also supports the writing of 'RTF' documents.
Examples of usage are:
Create Word documents with tables, titles, TOC and graphics
Importation of Word and PowerPoint files into data objects
Write updated content back to a PowerPoint presentation
Clinical reporting automation
Production of reports from a shiny application
To start with officer, read about read_docx()
, read_pptx()
or rtf_doc()
.
The package is also providing several objects that can be printed
in 'R Markdown' documents for advanced Word or PowerPoint
reporting as run_autonum()
and block_caption()
.
Maintainer: David Gohel [email protected]
Authors:
Stefan Moog [email protected]
Mark Heckmann [email protected] (ORCID)
Other contributors:
ArData [copyright holder]
Frank Hangler [email protected] (function body_replace_all_text) [contributor]
Liz Sander [email protected] (several documentation fixes) [contributor]
Anton Victorson [email protected] (fixes xml structures) [contributor]
Jon Calder [email protected] (update vignettes) [contributor]
John Harrold [email protected] (function annotate_base) [contributor]
John Muschelli [email protected] (google doc compatibility) [contributor]
Bill Denney [email protected] (ORCID) (function as.matrix.rpptx) [contributor]
Nikolai Beck [email protected] (set speaker notes for .pptx documents) [contributor]
Greg Leleu [email protected] (fields functionality in ppt) [contributor]
Majid Eismann [contributor]
Hongyuan Jia [email protected] (ORCID) [contributor]
The user documentation: https://ardata-fr.github.io/officeverse/ and manuals https://davidgohel.github.io/officer/
Defunct Functions in Package officer
slip_in_seqfield(...) slip_in_column_break(...) slip_in_xml(...) slip_in_text(...) slip_in_footnote(...)
slip_in_seqfield(...) slip_in_column_break(...) slip_in_xml(...) slip_in_text(...) slip_in_footnote(...)
... |
unused arguments |
slip_in_seqfield()
is replaced by run_word_field()
.
slip_in_column_break()
is replaced by run_columnbreak()
.
slip_in_xml()
is replaced by fpar()
.
slip_in_text()
is replaced by fpar()
.
slip_in_footnote()
is replaced by run_footnote()
.
Change current slide index of an rpptx object.
on_slide(x, index)
on_slide(x, index)
x |
an rpptx object |
index |
slide index |
Other functions slide manipulation:
add_slide()
,
move_slide()
,
remove_slide()
,
set_notes()
doc <- read_pptx() doc <- add_slide(doc, layout = "Title and Content", master = "Office Theme") doc <- add_slide(doc, layout = "Title and Content", master = "Office Theme") doc <- add_slide(doc, layout = "Title and Content", master = "Office Theme") doc <- on_slide(doc, index = 1) doc <- ph_with( x = doc, "First title", location = ph_location_type(type = "title") ) doc <- on_slide(doc, index = 3) doc <- ph_with( x = doc, "Third title", location = ph_location_type(type = "title") ) file <- tempfile(fileext = ".pptx") print(doc, target = file)
doc <- read_pptx() doc <- add_slide(doc, layout = "Title and Content", master = "Office Theme") doc <- add_slide(doc, layout = "Title and Content", master = "Office Theme") doc <- add_slide(doc, layout = "Title and Content", master = "Office Theme") doc <- on_slide(doc, index = 1) doc <- ph_with( x = doc, "First title", location = ph_location_type(type = "title") ) doc <- on_slide(doc, index = 3) doc <- ph_with( x = doc, "Third title", location = ph_location_type(type = "title") ) file <- tempfile(fileext = ".pptx") print(doc, target = file)
The margins for each page of a sectionThe function creates a representation of the dimensions of a page. The dimensions are defined by length, width and orientation. If the orientation is in landscape mode then the length becomes the width and the width becomes the length.
page_mar( bottom = 1, top = 1, right = 1, left = 1, header = 0.5, footer = 0.5, gutter = 0.5 )
page_mar( bottom = 1, top = 1, right = 1, left = 1, header = 0.5, footer = 0.5, gutter = 0.5 )
bottom , top
|
distance (in inches) between the bottom/top of the text margin and the bottom/top of the page. The text is placed at the greater of the value of this attribute and the extent of the header/footer text. A negative value indicates that the content should be measured from the bottom/topp of the page regardless of the footer/header, and so will overlap the footer/header. For example, |
left , right
|
distance (in inches) from the left/right edge of the page to the left/right edge of the text. |
header |
distance (in inches) from the top edge of the page to the top edge of the header. |
footer |
distance (in inches) from the bottom edge of the page to the bottom edge of the footer. |
gutter |
page gutter (in inches). |
Other functions for section definition:
page_size()
,
prop_section()
,
section_columns()
page_mar()
page_mar()
The function creates a representation of the dimensions of a page. The dimensions are defined by length, width and orientation. If the orientation is in landscape mode then the length becomes the width and the width becomes the length.
page_size( width = 21/2.54, height = 29.7/2.54, orient = "portrait", unit = "in" )
page_size( width = 21/2.54, height = 29.7/2.54, orient = "portrait", unit = "in" )
width , height
|
page width, page height (in inches). |
orient |
page orientation, either 'landscape', either 'portrait'. |
unit |
unit for width and height, one of "in", "cm", "mm". |
Other functions for section definition:
page_mar()
,
prop_section()
,
section_columns()
page_size(orient = "landscape")
page_size(orient = "landscape")
Add hyperlink to a placeholder in the current slide.
ph_hyperlink(x, type = "body", id = 1, id_chr = NULL, ph_label = NULL, href)
ph_hyperlink(x, type = "body", id = 1, id_chr = NULL, ph_label = NULL, href)
x |
an rpptx object |
type |
placeholder type |
id |
placeholder index (integer) for a duplicated type. This is to be used when a placeholder
type is not unique in the layout of the current slide, e.g. two placeholders with type 'body'. To
add onto the first, use |
id_chr |
deprecated. |
ph_label |
label associated to the placeholder. Use column
|
href |
hyperlink (do not forget http or https prefix) |
Other functions for placeholders manipulation:
ph_remove()
,
ph_slidelink()
fileout <- tempfile(fileext = ".pptx") loc_manual <- ph_location(bg = "red", newlabel = "mytitle") doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(x = doc, "Un titre 1", location = loc_manual) slide_summary(doc) # read column ph_label here doc <- ph_hyperlink( x = doc, ph_label = "mytitle", href = "https://cran.r-project.org" ) print(doc, target = fileout)
fileout <- tempfile(fileext = ".pptx") loc_manual <- ph_location(bg = "red", newlabel = "mytitle") doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(x = doc, "Un titre 1", location = loc_manual) slide_summary(doc) # read column ph_label here doc <- ph_hyperlink( x = doc, ph_label = "mytitle", href = "https://cran.r-project.org" ) print(doc, target = fileout)
The function will return a list that complies with
expected format for argument location
of function ph_with
.
ph_location( left = 1, top = 1, width = 4, height = 3, newlabel = "", bg = NULL, rotation = NULL, ln = NULL, geom = NULL, ... )
ph_location( left = 1, top = 1, width = 4, height = 3, newlabel = "", bg = NULL, rotation = NULL, ln = NULL, geom = NULL, ... )
left , top , width , height
|
place holder coordinates in inches. |
newlabel |
a label for the placeholder. See section details. |
bg |
background color |
rotation |
rotation angle |
ln |
a |
geom |
shape geometry, see http://www.datypic.com/sc/ooxml/t-a_ST_ShapeType.html |
... |
unused arguments |
The location of the bounding box associated to a placeholder within a slide is specified with the left top coordinate, the width and the height. These are defined in inches:
left coordinate of the bounding box
top coordinate of the bounding box
width of the bounding box
height of the bounding box
In addition to these attributes, a label can be
associated with the shape. Shapes, text boxes, images and other objects
will be identified with that label in the Selection Pane of PowerPoint.
This label can then be reused by other functions such as ph_location_label()
.
It can be set with argument newlabel
.
Other functions for placeholder location:
ph_location_fullsize()
,
ph_location_id()
,
ph_location_label()
,
ph_location_left()
,
ph_location_right()
,
ph_location_template()
,
ph_location_type()
doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(doc, "Hello world", location = ph_location(width = 4, height = 3, newlabel = "hello") ) print(doc, target = tempfile(fileext = ".pptx") ) # Set geometry and outline doc <- read_pptx() doc <- add_slide(doc) loc <- ph_location(left = 1, top = 1, width = 4, height = 3, bg = "steelblue", ln = sp_line(color = "red", lwd = 2.5), geom = "trapezoid") doc <- ph_with(doc, "", loc = loc) print(doc, target = tempfile(fileext = ".pptx") )
doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(doc, "Hello world", location = ph_location(width = 4, height = 3, newlabel = "hello") ) print(doc, target = tempfile(fileext = ".pptx") ) # Set geometry and outline doc <- read_pptx() doc <- add_slide(doc) loc <- ph_location(left = 1, top = 1, width = 4, height = 3, bg = "steelblue", ln = sp_line(color = "red", lwd = 2.5), geom = "trapezoid") doc <- ph_with(doc, "", loc = loc) print(doc, target = tempfile(fileext = ".pptx") )
The function will return the location corresponding to a full size display.
ph_location_fullsize(newlabel = "", ...)
ph_location_fullsize(newlabel = "", ...)
newlabel |
a label to associate with the placeholder. |
... |
unused arguments |
Other functions for placeholder location:
ph_location()
,
ph_location_id()
,
ph_location_label()
,
ph_location_left()
,
ph_location_right()
,
ph_location_template()
,
ph_location_type()
doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(doc, "Hello world", location = ph_location_fullsize() ) print(doc, target = tempfile(fileext = ".pptx") )
doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(doc, "Hello world", location = ph_location_fullsize() ) print(doc, target = tempfile(fileext = ".pptx") )
Each placeholder has an id (a low integer value). The ids are unique across a single
layout. The function uses the placeholder's id to reference it. Different from a ph label,
the id is auto-assigned by PowerPoint and cannot be modified by the user.
Use layout_properties()
(column id
) and plot_layout_properties()
(upper right
corner, in green) to find a placeholder's id.
ph_location_id(id, newlabel = NULL, ...)
ph_location_id(id, newlabel = NULL, ...)
id |
placeholder id. |
newlabel |
a new label to associate with the placeholder. |
... |
not used. |
The location of the bounding box associated to a placeholder within a slide is specified with the left top coordinate, the width and the height. These are defined in inches:
left coordinate of the bounding box
top coordinate of the bounding box
width of the bounding box
height of the bounding box
In addition to these attributes, a label can be
associated with the shape. Shapes, text boxes, images and other objects
will be identified with that label in the Selection Pane of PowerPoint.
This label can then be reused by other functions such as ph_location_label()
.
It can be set with argument newlabel
.
Other functions for placeholder location:
ph_location()
,
ph_location_fullsize()
,
ph_location_label()
,
ph_location_left()
,
ph_location_right()
,
ph_location_template()
,
ph_location_type()
doc <- read_pptx() doc <- add_slide(doc, "Comparison") plot_layout_properties(doc, "Comparison") doc <- ph_with(doc, "The Title", location = ph_location_id(id = 2)) # title doc <- ph_with(doc, "Left Header", location = ph_location_id(id = 3)) # left header doc <- ph_with(doc, "Left Content", location = ph_location_id(id = 4)) # left content doc <- ph_with(doc, "The Footer", location = ph_location_id(id = 8)) # footer file <- tempfile(fileext = ".pptx") print(doc, file) ## Not run: file.show(file) # may not work on your system ## End(Not run)
doc <- read_pptx() doc <- add_slide(doc, "Comparison") plot_layout_properties(doc, "Comparison") doc <- ph_with(doc, "The Title", location = ph_location_id(id = 2)) # title doc <- ph_with(doc, "Left Header", location = ph_location_id(id = 3)) # left header doc <- ph_with(doc, "Left Content", location = ph_location_id(id = 4)) # left content doc <- ph_with(doc, "The Footer", location = ph_location_id(id = 8)) # footer file <- tempfile(fileext = ".pptx") print(doc, file) ## Not run: file.show(file) # may not work on your system ## End(Not run)
The function will use the label of a placeholder to find the corresponding location.
ph_location_label(ph_label, newlabel = NULL, ...)
ph_location_label(ph_label, newlabel = NULL, ...)
ph_label |
placeholder label of the used layout. It can be read in PowerPoint or
with function |
newlabel |
a label to associate with the placeholder. |
... |
unused arguments |
The location of the bounding box associated to a placeholder within a slide is specified with the left top coordinate, the width and the height. These are defined in inches:
left coordinate of the bounding box
top coordinate of the bounding box
width of the bounding box
height of the bounding box
In addition to these attributes, a label can be
associated with the shape. Shapes, text boxes, images and other objects
will be identified with that label in the Selection Pane of PowerPoint.
This label can then be reused by other functions such as ph_location_label()
.
It can be set with argument newlabel
.
Other functions for placeholder location:
ph_location()
,
ph_location_fullsize()
,
ph_location_id()
,
ph_location_left()
,
ph_location_right()
,
ph_location_template()
,
ph_location_type()
# ph_location_label demo ---- doc <- read_pptx() doc <- add_slide(doc, layout = "Title and Content") # all ph_label can be read here layout_properties(doc, layout = "Title and Content") doc <- ph_with(doc, head(iris), location = ph_location_label(ph_label = "Content Placeholder 2") ) doc <- ph_with(doc, format(Sys.Date()), location = ph_location_label(ph_label = "Date Placeholder 3") ) doc <- ph_with(doc, "This is a title", location = ph_location_label(ph_label = "Title 1") ) print(doc, target = tempfile(fileext = ".pptx"))
# ph_location_label demo ---- doc <- read_pptx() doc <- add_slide(doc, layout = "Title and Content") # all ph_label can be read here layout_properties(doc, layout = "Title and Content") doc <- ph_with(doc, head(iris), location = ph_location_label(ph_label = "Content Placeholder 2") ) doc <- ph_with(doc, format(Sys.Date()), location = ph_location_label(ph_label = "Date Placeholder 3") ) doc <- ph_with(doc, "This is a title", location = ph_location_label(ph_label = "Title 1") ) print(doc, target = tempfile(fileext = ".pptx"))
The function will return the location corresponding
to a left bounding box. The function assume the layout 'Two Content'
is existing. This is an helper function, if you don't have a layout
named 'Two Content', use ph_location_type()
and set arguments
to your specific needs.
ph_location_left(newlabel = NULL, ...)
ph_location_left(newlabel = NULL, ...)
newlabel |
a label to associate with the placeholder. |
... |
unused arguments |
Other functions for placeholder location:
ph_location()
,
ph_location_fullsize()
,
ph_location_id()
,
ph_location_label()
,
ph_location_right()
,
ph_location_template()
,
ph_location_type()
doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(doc, "Hello left", location = ph_location_left() ) doc <- ph_with(doc, "Hello right", location = ph_location_right() ) print(doc, target = tempfile(fileext = ".pptx") )
doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(doc, "Hello left", location = ph_location_left() ) doc <- ph_with(doc, "Hello right", location = ph_location_right() ) print(doc, target = tempfile(fileext = ".pptx") )
The function will return the location corresponding
to a right bounding box. The function assume the layout 'Two Content'
is existing. This is an helper function, if you don't have a layout
named 'Two Content', use ph_location_type()
and set arguments
to your specific needs.
ph_location_right(newlabel = NULL, ...)
ph_location_right(newlabel = NULL, ...)
newlabel |
a label to associate with the placeholder. |
... |
unused arguments |
Other functions for placeholder location:
ph_location()
,
ph_location_fullsize()
,
ph_location_id()
,
ph_location_label()
,
ph_location_left()
,
ph_location_template()
,
ph_location_type()
doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(doc, "Hello left", location = ph_location_left() ) doc <- ph_with(doc, "Hello right", location = ph_location_right() ) print(doc, target = tempfile(fileext = ".pptx") )
doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(doc, "Hello left", location = ph_location_left() ) doc <- ph_with(doc, "Hello right", location = ph_location_right() ) print(doc, target = tempfile(fileext = ".pptx") )
The function will return a list that complies with
expected format for argument location
of function
ph_with
. A placeholder will be used as template
and its positions will be updated with values left
, top
, width
, height
.
ph_location_template( left = 1, top = 1, width = 4, height = 3, newlabel = "", type = NULL, id = 1, ... )
ph_location_template( left = 1, top = 1, width = 4, height = 3, newlabel = "", type = NULL, id = 1, ... )
left , top , width , height
|
place holder coordinates in inches. |
newlabel |
a label for the placeholder. See section details. |
type |
placeholder type to look for in the slide layout, one of 'body', 'title', 'ctrTitle', 'subTitle', 'dt', 'ftr', 'sldNum'. It will be used as a template placeholder. |
id |
index of the placeholder template. If two body placeholder, there can be two different index: 1 and 2 for the first and second body placeholders defined in the layout. |
... |
unused arguments |
The location of the bounding box associated to a placeholder within a slide is specified with the left top coordinate, the width and the height. These are defined in inches:
left coordinate of the bounding box
top coordinate of the bounding box
width of the bounding box
height of the bounding box
In addition to these attributes, a label can be
associated with the shape. Shapes, text boxes, images and other objects
will be identified with that label in the Selection Pane of PowerPoint.
This label can then be reused by other functions such as ph_location_label()
.
It can be set with argument newlabel
.
Other functions for placeholder location:
ph_location()
,
ph_location_fullsize()
,
ph_location_id()
,
ph_location_label()
,
ph_location_left()
,
ph_location_right()
,
ph_location_type()
doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(doc, "Title", location = ph_location_type(type = "title") ) doc <- ph_with(doc, "Hello world", location = ph_location_template(top = 4, type = "title") ) print(doc, target = tempfile(fileext = ".pptx") )
doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(doc, "Title", location = ph_location_type(type = "title") ) doc <- ph_with(doc, "Hello world", location = ph_location_template(top = 4, type = "title") ) print(doc, target = tempfile(fileext = ".pptx") )
The function will use the type name of the placeholder (e.g. body, title), the layout name and few other criterias to find the corresponding location.
ph_location_type( type = "body", type_idx = NULL, position_right = TRUE, position_top = TRUE, newlabel = NULL, id = NULL, ... )
ph_location_type( type = "body", type_idx = NULL, position_right = TRUE, position_top = TRUE, newlabel = NULL, id = NULL, ... )
type |
placeholder type to look for in the slide layout, one of 'body', 'title', 'ctrTitle', 'subTitle', 'dt', 'ftr', 'sldNum'. |
type_idx |
Type index of the placeholder. If there is more than one
placeholder of a type (e.g., |
position_right |
the parameter is used when a selection with above
parameters does not provide a unique position (for example
layout 'Two Content' contains two element of type 'body').
If |
position_top |
same than |
newlabel |
a label to associate with the placeholder. |
id |
(DEPRECATED, use |
... |
unused arguments |
The location of the bounding box associated to a placeholder within a slide is specified with the left top coordinate, the width and the height. These are defined in inches:
left coordinate of the bounding box
top coordinate of the bounding box
width of the bounding box
height of the bounding box
In addition to these attributes, a label can be
associated with the shape. Shapes, text boxes, images and other objects
will be identified with that label in the Selection Pane of PowerPoint.
This label can then be reused by other functions such as ph_location_label()
.
It can be set with argument newlabel
.
Other functions for placeholder location:
ph_location()
,
ph_location_fullsize()
,
ph_location_id()
,
ph_location_label()
,
ph_location_left()
,
ph_location_right()
,
ph_location_template()
# ph_location_type demo ---- loc_title <- ph_location_type(type = "title") loc_footer <- ph_location_type(type = "ftr") loc_dt <- ph_location_type(type = "dt") loc_slidenum <- ph_location_type(type = "sldNum") loc_body <- ph_location_type(type = "body") doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(x = doc, "Un titre", location = loc_title) doc <- ph_with(x = doc, "pied de page", location = loc_footer) doc <- ph_with(x = doc, format(Sys.Date()), location = loc_dt) doc <- ph_with(x = doc, "slide 1", location = loc_slidenum) doc <- ph_with(x = doc, letters[1:10], location = loc_body) loc_subtitle <- ph_location_type(type = "subTitle") loc_ctrtitle <- ph_location_type(type = "ctrTitle") doc <- add_slide(doc, layout = "Title Slide", master = "Office Theme") doc <- ph_with(x = doc, "Un sous titre", location = loc_subtitle) doc <- ph_with(x = doc, "Un titre", location = loc_ctrtitle) fileout <- tempfile(fileext = ".pptx") print(doc, target = fileout)
# ph_location_type demo ---- loc_title <- ph_location_type(type = "title") loc_footer <- ph_location_type(type = "ftr") loc_dt <- ph_location_type(type = "dt") loc_slidenum <- ph_location_type(type = "sldNum") loc_body <- ph_location_type(type = "body") doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(x = doc, "Un titre", location = loc_title) doc <- ph_with(x = doc, "pied de page", location = loc_footer) doc <- ph_with(x = doc, format(Sys.Date()), location = loc_dt) doc <- ph_with(x = doc, "slide 1", location = loc_slidenum) doc <- ph_with(x = doc, letters[1:10], location = loc_body) loc_subtitle <- ph_location_type(type = "subTitle") loc_ctrtitle <- ph_location_type(type = "ctrTitle") doc <- add_slide(doc, layout = "Title Slide", master = "Office Theme") doc <- ph_with(x = doc, "Un sous titre", location = loc_subtitle) doc <- ph_with(x = doc, "Un titre", location = loc_ctrtitle) fileout <- tempfile(fileext = ".pptx") print(doc, target = fileout)
Remove a shape in a slide.
ph_remove(x, type = "body", id = 1, ph_label = NULL, id_chr = NULL)
ph_remove(x, type = "body", id = 1, ph_label = NULL, id_chr = NULL)
x |
an rpptx object |
type |
placeholder type |
id |
placeholder index (integer) for a duplicated type. This is to be used when a placeholder
type is not unique in the layout of the current slide, e.g. two placeholders with type 'body'. To
add onto the first, use |
ph_label |
label associated to the placeholder. Use column
|
id_chr |
deprecated. |
Other functions for placeholders manipulation:
ph_hyperlink()
,
ph_slidelink()
fileout <- tempfile(fileext = ".pptx") dummy_fun <- function(doc) { doc <- add_slide(doc, layout = "Two Content", master = "Office Theme" ) doc <- ph_with( x = doc, value = "Un titre", location = ph_location_type(type = "title") ) doc <- ph_with( x = doc, value = "Un corps 1", location = ph_location_type(type = "body", id = 1) ) doc <- ph_with( x = doc, value = "Un corps 2", location = ph_location_type(type = "body", id = 2) ) doc } doc <- read_pptx() for (i in 1:3) { doc <- dummy_fun(doc) } doc <- on_slide(doc, index = 1) doc <- ph_remove(x = doc, type = "title") doc <- on_slide(doc, index = 2) doc <- ph_remove(x = doc, type = "body", id = 2) doc <- on_slide(doc, index = 3) doc <- ph_remove(x = doc, type = "body", id = 1) print(doc, target = fileout)
fileout <- tempfile(fileext = ".pptx") dummy_fun <- function(doc) { doc <- add_slide(doc, layout = "Two Content", master = "Office Theme" ) doc <- ph_with( x = doc, value = "Un titre", location = ph_location_type(type = "title") ) doc <- ph_with( x = doc, value = "Un corps 1", location = ph_location_type(type = "body", id = 1) ) doc <- ph_with( x = doc, value = "Un corps 2", location = ph_location_type(type = "body", id = 2) ) doc } doc <- read_pptx() for (i in 1:3) { doc <- dummy_fun(doc) } doc <- on_slide(doc, index = 1) doc <- ph_remove(x = doc, type = "title") doc <- on_slide(doc, index = 2) doc <- ph_remove(x = doc, type = "body", id = 2) doc <- on_slide(doc, index = 3) doc <- ph_remove(x = doc, type = "body", id = 1) print(doc, target = fileout)
Add slide link to a placeholder in the current slide.
ph_slidelink( x, type = "body", id = 1, id_chr = NULL, ph_label = NULL, slide_index )
ph_slidelink( x, type = "body", id = 1, id_chr = NULL, ph_label = NULL, slide_index )
x |
an rpptx object |
type |
placeholder type |
id |
placeholder index (integer) for a duplicated type. This is to be used when a placeholder
type is not unique in the layout of the current slide, e.g. two placeholders with type 'body'. To
add onto the first, use |
id_chr |
deprecated. |
ph_label |
label associated to the placeholder. Use column
|
slide_index |
slide index to reach |
Other functions for placeholders manipulation:
ph_hyperlink()
,
ph_remove()
fileout <- tempfile(fileext = ".pptx") loc_title <- ph_location_type(type = "title") doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(x = doc, "Un titre 1", location = loc_title) doc <- add_slide(doc) doc <- ph_with(x = doc, "Un titre 2", location = loc_title) doc <- on_slide(doc, 1) slide_summary(doc) # read column ph_label here doc <- ph_slidelink(x = doc, ph_label = "Title 1", slide_index = 2) print(doc, target = fileout)
fileout <- tempfile(fileext = ".pptx") loc_title <- ph_location_type(type = "title") doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with(x = doc, "Un titre 1", location = loc_title) doc <- add_slide(doc) doc <- ph_with(x = doc, "Un titre 2", location = loc_title) doc <- on_slide(doc, 1) slide_summary(doc) # read column ph_label here doc <- ph_slidelink(x = doc, ph_label = "Title 1", slide_index = 2) print(doc, target = fileout)
add object into a new shape in the current slide. This function is able to add all supported outputs to a presentation. See section Methods (by class) to see supported outputs.
ph_with(x, value, location, ...) ## S3 method for class 'character' ph_with(x, value, location, ...) ## S3 method for class 'numeric' ph_with(x, value, location, format_fun = format, ...) ## S3 method for class 'factor' ph_with(x, value, location, ...) ## S3 method for class 'logical' ph_with(x, value, location, format_fun = format, ...) ## S3 method for class 'block_list' ph_with(x, value, location, level_list = integer(0), ...) ## S3 method for class 'unordered_list' ph_with(x, value, location, ...) ## S3 method for class 'data.frame' ph_with( x, value, location, header = TRUE, tcf = table_conditional_formatting(), alignment = NULL, ... ) ## S3 method for class 'gg' ph_with(x, value, location, res = 300, alt_text = "", scale = 1, ...) ## S3 method for class 'plot_instr' ph_with(x, value, location, res = 300, ...) ## S3 method for class 'external_img' ph_with(x, value, location, use_loc_size = TRUE, ...) ## S3 method for class 'fpar' ph_with(x, value, location, ...) ## S3 method for class 'empty_content' ph_with(x, value, location, ...) ## S3 method for class 'xml_document' ph_with(x, value, location, ...)
ph_with(x, value, location, ...) ## S3 method for class 'character' ph_with(x, value, location, ...) ## S3 method for class 'numeric' ph_with(x, value, location, format_fun = format, ...) ## S3 method for class 'factor' ph_with(x, value, location, ...) ## S3 method for class 'logical' ph_with(x, value, location, format_fun = format, ...) ## S3 method for class 'block_list' ph_with(x, value, location, level_list = integer(0), ...) ## S3 method for class 'unordered_list' ph_with(x, value, location, ...) ## S3 method for class 'data.frame' ph_with( x, value, location, header = TRUE, tcf = table_conditional_formatting(), alignment = NULL, ... ) ## S3 method for class 'gg' ph_with(x, value, location, res = 300, alt_text = "", scale = 1, ...) ## S3 method for class 'plot_instr' ph_with(x, value, location, res = 300, ...) ## S3 method for class 'external_img' ph_with(x, value, location, use_loc_size = TRUE, ...) ## S3 method for class 'fpar' ph_with(x, value, location, ...) ## S3 method for class 'empty_content' ph_with(x, value, location, ...) ## S3 method for class 'xml_document' ph_with(x, value, location, ...)
x |
an rpptx object |
value |
object to add as a new shape. Supported objects are vectors, data.frame, graphics, block of formatted paragraphs, unordered list of formatted paragraphs, pretty tables with package flextable, editable graphics with package rvg, 'Microsoft' charts with package mschart. |
location |
a placeholder location object.
It will be used to specify the location of the new shape. This location
can be defined with a call to one of the ph_location functions. See
section |
... |
further arguments passed to or from other methods. When
adding a |
format_fun |
format function for non character vectors |
level_list |
The list of levels for hierarchy structure as integer values. If used the object is formated as an unordered list. If 1 and 2, item 1 level will be 1, item 2 level will be 2. |
header |
display header if TRUE |
tcf |
conditional formatting settings defined by |
alignment |
alignment for each columns, 'l' for left, 'r' for right and 'c' for center. Default to NULL. |
res |
resolution of the png image in ppi |
alt_text |
Alt-text for screen-readers. Defaults to |
scale |
Multiplicative scaling factor, same as in ggsave |
use_loc_size |
if set to FALSE, external_img width and height will be used. |
ph_with(character)
: add a character vector to a new shape on the
current slide, values will be added as paragraphs.
ph_with(numeric)
: add a numeric vector to a new shape on the
current slide, values will be be first formatted then
added as paragraphs.
ph_with(factor)
: add a factor vector to a new shape on the
current slide, values will be be converted as character and then
added as paragraphs.
ph_with(block_list)
: add a block_list
made
of fpar
to a new shape on the current slide.
ph_with(unordered_list)
: add a unordered_list
made
of fpar
to a new shape on the current slide.
ph_with(data.frame)
: add a data.frame to a new shape on the current slide with
function block_table()
. Use package flextable
instead for more
advanced formattings.
ph_with(gg)
: add a ggplot object to a new shape on the
current slide. Use package rvg
for more advanced graphical features.
ph_with(plot_instr)
: add an R plot to a new shape on the
current slide. Use package rvg
for more advanced graphical features.
ph_with(external_img)
: add a external_img
to a new shape
on the current slide.
When value is a external_img object, image will be copied
into the PowerPoint presentation. The width and height
specified in call to external_img
will be
ignored, their values will be those of the location,
unless use_loc_size is set to FALSE.
ph_with(fpar)
: add an fpar
to a new shape
on the current slide as a single paragraph in a block_list
.
ph_with(empty_content)
: add an empty_content
to a new shape
on the current slide.
ph_with(xml_document)
: add an xml_document object to a new shape on the
current slide. This function is to be used to add custom openxml code.
ph_location_type, ph_location, ph_location_label, ph_location_left, ph_location_right, ph_location_fullsize, ph_location_template
# this name will be used to print the file # change it to "youfile.pptx" to write the pptx # file in your working directory. fileout <- tempfile(fileext = ".pptx") doc_1 <- read_pptx() sz <- slide_size(doc_1) # add text and a table ---- doc_1 <- add_slide(doc_1, layout = "Two Content", master = "Office Theme") doc_1 <- ph_with( x = doc_1, value = c("Table cars"), location = ph_location_type(type = "title") ) doc_1 <- ph_with( x = doc_1, value = names(cars), location = ph_location_left() ) doc_1 <- ph_with( x = doc_1, value = cars, location = ph_location_right() ) # add a base plot ---- anyplot <- plot_instr(code = { col <- c( "#440154FF", "#443A83FF", "#31688EFF", "#21908CFF", "#35B779FF", "#8FD744FF", "#FDE725FF" ) barplot(1:7, col = col, yaxt = "n") }) doc_1 <- add_slide(doc_1) doc_1 <- ph_with(doc_1, anyplot, location = ph_location_fullsize(), bg = "#006699" ) # add a ggplot2 plot ---- if (require("ggplot2")) { doc_1 <- add_slide(doc_1) gg_plot <- ggplot(data = iris) + geom_point( mapping = aes(Sepal.Length, Petal.Length), size = 3 ) + theme_minimal() doc_1 <- ph_with( x = doc_1, value = gg_plot, location = ph_location_type(type = "body"), bg = "transparent" ) doc_1 <- ph_with( x = doc_1, value = "graphic title", location = ph_location_type(type = "title") ) } # add a external images ---- doc_1 <- add_slide(doc_1, layout = "Title and Content", master = "Office Theme" ) doc_1 <- ph_with( x = doc_1, value = empty_content(), location = ph_location( left = 0, top = 0, width = sz$width, height = sz$height, bg = "black" ) ) svg_file <- file.path(R.home(component = "doc"), "html/Rlogo.svg") if (require("rsvg")) { doc_1 <- ph_with( x = doc_1, value = "External images", location = ph_location_type(type = "title") ) doc_1 <- ph_with( x = doc_1, external_img(svg_file, 100 / 72, 76 / 72), location = ph_location_right(), use_loc_size = FALSE ) doc_1 <- ph_with( x = doc_1, external_img(svg_file), location = ph_location_left(), use_loc_size = TRUE ) } # add a block_list ---- dummy_text <- readLines(system.file( package = "officer", "doc_examples/text.txt" )) fp_1 <- fp_text(bold = TRUE, color = "pink", font.size = 0) fp_2 <- fp_text(bold = TRUE, font.size = 0) fp_3 <- fp_text(italic = TRUE, color = "red", font.size = 0) bl <- block_list( fpar(ftext("hello world", fp_1)), fpar( ftext("hello", fp_2), ftext("hello", fp_3) ), dummy_text ) doc_1 <- add_slide(doc_1) doc_1 <- ph_with( x = doc_1, value = bl, location = ph_location_type(type = "body") ) # fpar ------ fpt <- fp_text( bold = TRUE, font.family = "Bradley Hand", font.size = 150, color = "#F5595B" ) hw <- fpar( ftext("hello ", fpt), hyperlink_ftext( href = "https://cran.r-project.org/index.html", text = "cran", prop = fpt ) ) doc_1 <- add_slide(doc_1) doc_1 <- ph_with( x = doc_1, value = hw, location = ph_location_type(type = "body") ) # unordered_list ---- ul <- unordered_list( level_list = c(1, 2, 2, 3, 3, 1), str_list = c("Level1", "Level2", "Level2", "Level3", "Level3", "Level1"), style = fp_text(color = "red", font.size = 0) ) doc_1 <- add_slide(doc_1) doc_1 <- ph_with( x = doc_1, value = ul, location = ph_location_type() ) print(doc_1, target = fileout)
# this name will be used to print the file # change it to "youfile.pptx" to write the pptx # file in your working directory. fileout <- tempfile(fileext = ".pptx") doc_1 <- read_pptx() sz <- slide_size(doc_1) # add text and a table ---- doc_1 <- add_slide(doc_1, layout = "Two Content", master = "Office Theme") doc_1 <- ph_with( x = doc_1, value = c("Table cars"), location = ph_location_type(type = "title") ) doc_1 <- ph_with( x = doc_1, value = names(cars), location = ph_location_left() ) doc_1 <- ph_with( x = doc_1, value = cars, location = ph_location_right() ) # add a base plot ---- anyplot <- plot_instr(code = { col <- c( "#440154FF", "#443A83FF", "#31688EFF", "#21908CFF", "#35B779FF", "#8FD744FF", "#FDE725FF" ) barplot(1:7, col = col, yaxt = "n") }) doc_1 <- add_slide(doc_1) doc_1 <- ph_with(doc_1, anyplot, location = ph_location_fullsize(), bg = "#006699" ) # add a ggplot2 plot ---- if (require("ggplot2")) { doc_1 <- add_slide(doc_1) gg_plot <- ggplot(data = iris) + geom_point( mapping = aes(Sepal.Length, Petal.Length), size = 3 ) + theme_minimal() doc_1 <- ph_with( x = doc_1, value = gg_plot, location = ph_location_type(type = "body"), bg = "transparent" ) doc_1 <- ph_with( x = doc_1, value = "graphic title", location = ph_location_type(type = "title") ) } # add a external images ---- doc_1 <- add_slide(doc_1, layout = "Title and Content", master = "Office Theme" ) doc_1 <- ph_with( x = doc_1, value = empty_content(), location = ph_location( left = 0, top = 0, width = sz$width, height = sz$height, bg = "black" ) ) svg_file <- file.path(R.home(component = "doc"), "html/Rlogo.svg") if (require("rsvg")) { doc_1 <- ph_with( x = doc_1, value = "External images", location = ph_location_type(type = "title") ) doc_1 <- ph_with( x = doc_1, external_img(svg_file, 100 / 72, 76 / 72), location = ph_location_right(), use_loc_size = FALSE ) doc_1 <- ph_with( x = doc_1, external_img(svg_file), location = ph_location_left(), use_loc_size = TRUE ) } # add a block_list ---- dummy_text <- readLines(system.file( package = "officer", "doc_examples/text.txt" )) fp_1 <- fp_text(bold = TRUE, color = "pink", font.size = 0) fp_2 <- fp_text(bold = TRUE, font.size = 0) fp_3 <- fp_text(italic = TRUE, color = "red", font.size = 0) bl <- block_list( fpar(ftext("hello world", fp_1)), fpar( ftext("hello", fp_2), ftext("hello", fp_3) ), dummy_text ) doc_1 <- add_slide(doc_1) doc_1 <- ph_with( x = doc_1, value = bl, location = ph_location_type(type = "body") ) # fpar ------ fpt <- fp_text( bold = TRUE, font.family = "Bradley Hand", font.size = 150, color = "#F5595B" ) hw <- fpar( ftext("hello ", fpt), hyperlink_ftext( href = "https://cran.r-project.org/index.html", text = "cran", prop = fpt ) ) doc_1 <- add_slide(doc_1) doc_1 <- ph_with( x = doc_1, value = hw, location = ph_location_type(type = "body") ) # unordered_list ---- ul <- unordered_list( level_list = c(1, 2, 2, 3, 3, 1), str_list = c("Level1", "Level2", "Level2", "Level3", "Level3", "Level1"), style = fp_text(color = "red", font.size = 0) ) doc_1 <- add_slide(doc_1) doc_1 <- ph_with( x = doc_1, value = ul, location = ph_location_type() ) print(doc_1, target = fileout)
A simple wrapper to capture
plot instructions that will be executed and copied in a document. It produces
an object of class 'plot_instr' with a corresponding method ph_with()
and
body_add_plot()
.
The function enable usage of any R plot with argument code
. Wrap your code
between curly bracket if more than a single expression.
plot_instr(code)
plot_instr(code)
code |
plotting instructions |
Other block functions for reporting:
block_caption()
,
block_list()
,
block_pour_docx()
,
block_section()
,
block_table()
,
block_toc()
,
fpar()
,
unordered_list()
# plot_instr demo ---- anyplot <- plot_instr(code = { barplot(1:5, col = 2:6) }) doc <- read_docx() doc <- body_add(doc, anyplot, width = 5, height = 4) print(doc, target = tempfile(fileext = ".docx")) doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with( doc, anyplot, location = ph_location_fullsize(), bg = "#00000066", pointsize = 12) print(doc, target = tempfile(fileext = ".pptx"))
# plot_instr demo ---- anyplot <- plot_instr(code = { barplot(1:5, col = 2:6) }) doc <- read_docx() doc <- body_add(doc, anyplot, width = 5, height = 4) print(doc, target = tempfile(fileext = ".docx")) doc <- read_pptx() doc <- add_slide(doc) doc <- ph_with( doc, anyplot, location = ph_location_fullsize(), bg = "#00000066", pointsize = 12) print(doc, target = tempfile(fileext = ".pptx"))
Plot slide layout properties into corresponding placeholders.
This can be useful to help visualize placeholders locations and identifiers.
All information in the plot stems from the layout_properties()
output.
See Details section for more info.
plot_layout_properties( x, layout = NULL, master = NULL, labels = TRUE, title = TRUE, type = TRUE, id = TRUE, cex = NULL, legend = FALSE )
plot_layout_properties( x, layout = NULL, master = NULL, labels = TRUE, title = TRUE, type = TRUE, id = TRUE, cex = NULL, legend = FALSE )
x |
an |
layout |
slide layout name or numeric index (row index from [layout_summary()). |
master |
master layout name where |
labels |
if |
title |
if |
type |
if |
id |
if |
cex |
named list or vector to specify font size for |
legend |
Add a legend to the plot (default |
The plot contains all relevant information to reference a placeholder via the ph_location_*
function family:
label
: ph label (red, center) to be used in ph_location_label()
.
NB: The label can be assigned by the user in PowerPoint.
type[idx]
: ph type + type index in brackets (blue, upper left) to be used in ph_location_type()
.
NB: The index is consecutive and is sorted by ph position (top -> bottom, left -> right).
id
: ph id (green, upper right) to be used in ph_location_id()
(forthcoming).
NB: The id is set by PowerPoint automatically and lack a meaningful order.
Other functions for reading presentation information:
annotate_base()
,
color_scheme()
,
doc_properties()
,
layout_properties()
,
layout_summary()
,
length.rpptx()
,
slide_size()
,
slide_summary()
x <- read_pptx() # select layout explicitly plot_layout_properties(x = x, layout = "Title Slide", master = "Office Theme") plot_layout_properties(x = x, layout = "Title Slide") # no master needed if layout name unique plot_layout_properties(x = x, layout = 1) # use layout index instead of name # plot current slide's layout (default if no layout is passed) x <- read_pptx() x <- add_slide(x, "Title Slide") plot_layout_properties(x) # change appearance: what to show, font size, legend etc. plot_layout_properties(x, layout = "Two Content", title = FALSE, type = FALSE, id = FALSE) plot_layout_properties(x, layout = 4, cex = c(labels = .8, id = .7, type = .7)) plot_layout_properties(x, 1, legend = TRUE)
x <- read_pptx() # select layout explicitly plot_layout_properties(x = x, layout = "Title Slide", master = "Office Theme") plot_layout_properties(x = x, layout = "Title Slide") # no master needed if layout name unique plot_layout_properties(x = x, layout = 1) # use layout index instead of name # plot current slide's layout (default if no layout is passed) x <- read_pptx() x <- add_slide(x, "Title Slide") plot_layout_properties(x) # change appearance: what to show, font size, legend etc. plot_layout_properties(x, layout = "Two Content", title = FALSE, type = FALSE, id = FALSE) plot_layout_properties(x, layout = 4, cex = c(labels = .8, id = .7, type = .7)) plot_layout_properties(x, 1, legend = TRUE)
Read content of a PowerPoint document and return a dataset representing the document.
pptx_summary(x, preserve = FALSE)
pptx_summary(x, preserve = FALSE)
x |
an rpptx object |
preserve |
If |
example_pptx <- system.file(package = "officer", "doc_examples/example.pptx") doc <- read_pptx(example_pptx) pptx_summary(doc) pptx_summary(example_pptx)
example_pptx <- system.file(package = "officer", "doc_examples/example.pptx") doc <- read_pptx(example_pptx) pptx_summary(doc) pptx_summary(example_pptx)
Write a 'PowerPoint' file
with an object of class 'rpptx' (created with
read_pptx()
).
## S3 method for class 'rpptx' print(x, target = NULL, ...)
## S3 method for class 'rpptx' print(x, target = NULL, ...)
x |
an rpptx object |
target |
path to the pptx file to write |
... |
unused |
# write a rdocx object in a pptx file ---- file <- tempfile(fileext = ".pptx") doc <- read_pptx() print(doc, target = file)
# write a rdocx object in a pptx file ---- file <- tempfile(fileext = ".pptx") doc <- read_pptx() print(doc, target = file)
Write the RTF object and its content to a file.
## S3 method for class 'rtf' print(x, target = NULL, ...)
## S3 method for class 'rtf' print(x, target = NULL, ...)
x |
an 'rtf' object created with |
target |
path to the RTF file to write |
... |
unused |
# write a rdocx object in a rtf file ---- doc <- rtf_doc() print(doc, target = tempfile(fileext = ".rtf"))
# write a rdocx object in a rtf file ---- doc <- rtf_doc() print(doc, target = tempfile(fileext = ".rtf"))
A section is a grouping of blocks (ie. paragraphs and tables) that have a set of properties that define pages on which the text will appear.
A Section properties object stores information about page composition, such as page size, page orientation, borders and margins.
prop_section( page_size = NULL, page_margins = NULL, type = NULL, section_columns = NULL, header_default = NULL, header_even = NULL, header_first = NULL, footer_default = NULL, footer_even = NULL, footer_first = NULL )
prop_section( page_size = NULL, page_margins = NULL, type = NULL, section_columns = NULL, header_default = NULL, header_even = NULL, header_first = NULL, footer_default = NULL, footer_even = NULL, footer_first = NULL )
page_size |
page dimensions, an object generated with function page_size. |
page_margins |
page margins, an object generated with function page_mar. |
type |
Section type. It defines how the contents of the section will be placed relative to the previous section. Available types are "continuous" (begins the section on the next paragraph), "evenPage" (begins on the next even-numbered page), "nextColumn" (begins on the next column on the page), "nextPage" (begins on the following page), "oddPage" (begins on the next odd-numbered page). |
section_columns |
section columns, an object generated with function section_columns. Use NULL (default value) for no content. |
header_default |
content as a |
header_even |
content as a |
header_first |
content as a |
footer_default |
content as a |
footer_even |
content as a |
footer_first |
content as a |
Other functions for section definition:
page_mar()
,
page_size()
,
section_columns()
library(officer) landscape_one_column <- block_section( prop_section( page_size = page_size(orient = "landscape"), type = "continuous" ) ) landscape_two_columns <- block_section( prop_section( page_size = page_size(orient = "landscape"), type = "continuous", section_columns = section_columns(widths = c(4.75, 4.75)) ) ) doc_1 <- read_docx() # there starts section with landscape_one_column doc_1 <- body_add_table(doc_1, value = mtcars[1:10, ], style = "table_template") doc_1 <- body_end_block_section(doc_1, value = landscape_one_column) # there stops section with landscape_one_column # there starts section with landscape_two_columns doc_1 <- body_add_par(doc_1, value = paste(rep(letters, 50), collapse = " ")) doc_1 <- body_end_block_section(doc_1, value = landscape_two_columns) # there stops section with landscape_two_columns doc_1 <- body_add_table(doc_1, value = mtcars[1:25, ], style = "table_template") print(doc_1, target = tempfile(fileext = ".docx")) # an example with headers and footers ----- txt_lorem <- rep( "Purus lectus eros metus turpis mattis platea praesent sed. ", 50 ) txt_lorem <- paste0(txt_lorem, collapse = "") header_first <- block_list(fpar(ftext("text for first page header"))) header_even <- block_list(fpar(ftext("text for even page header"))) header_default <- block_list(fpar(ftext("text for default page header"))) footer_first <- block_list(fpar(ftext("text for first page footer"))) footer_even <- block_list(fpar(ftext("text for even page footer"))) footer_default <- block_list(fpar(ftext("text for default page footer"))) ps <- prop_section( header_default = header_default, footer_default = footer_default, header_first = header_first, footer_first = footer_first, header_even = header_even, footer_even = footer_even ) x <- read_docx() for (i in 1:20) { x <- body_add_par(x, value = txt_lorem) } x <- body_set_default_section( x, value = ps ) print(x, target = tempfile(fileext = ".docx"))
library(officer) landscape_one_column <- block_section( prop_section( page_size = page_size(orient = "landscape"), type = "continuous" ) ) landscape_two_columns <- block_section( prop_section( page_size = page_size(orient = "landscape"), type = "continuous", section_columns = section_columns(widths = c(4.75, 4.75)) ) ) doc_1 <- read_docx() # there starts section with landscape_one_column doc_1 <- body_add_table(doc_1, value = mtcars[1:10, ], style = "table_template") doc_1 <- body_end_block_section(doc_1, value = landscape_one_column) # there stops section with landscape_one_column # there starts section with landscape_two_columns doc_1 <- body_add_par(doc_1, value = paste(rep(letters, 50), collapse = " ")) doc_1 <- body_end_block_section(doc_1, value = landscape_two_columns) # there stops section with landscape_two_columns doc_1 <- body_add_table(doc_1, value = mtcars[1:25, ], style = "table_template") print(doc_1, target = tempfile(fileext = ".docx")) # an example with headers and footers ----- txt_lorem <- rep( "Purus lectus eros metus turpis mattis platea praesent sed. ", 50 ) txt_lorem <- paste0(txt_lorem, collapse = "") header_first <- block_list(fpar(ftext("text for first page header"))) header_even <- block_list(fpar(ftext("text for even page header"))) header_default <- block_list(fpar(ftext("text for default page header"))) footer_first <- block_list(fpar(ftext("text for first page footer"))) footer_even <- block_list(fpar(ftext("text for even page footer"))) footer_default <- block_list(fpar(ftext("text for default page footer"))) ps <- prop_section( header_default = header_default, footer_default = footer_default, header_first = header_first, footer_first = footer_first, header_even = header_even, footer_even = footer_even ) x <- read_docx() for (i in 1:20) { x <- body_add_par(x, value = txt_lorem) } x <- body_set_default_section( x, value = ps ) print(x, target = tempfile(fileext = ".docx"))
Define table properties such as fixed or autofit layout, table width in the document, eventually column widths.
prop_table( style = NA_character_, layout = table_layout(), width = table_width(), stylenames = table_stylenames(), colwidths = table_colwidths(), tcf = table_conditional_formatting(), align = "center", word_title = NULL, word_description = NULL )
prop_table( style = NA_character_, layout = table_layout(), width = table_width(), stylenames = table_stylenames(), colwidths = table_colwidths(), tcf = table_conditional_formatting(), align = "center", word_title = NULL, word_description = NULL )
style |
table style to be used to format table |
layout |
layout defined by |
width |
table width in the document defined by |
stylenames |
columns styles defined by |
colwidths |
column widths defined by |
tcf |
conditional formatting settings defined by |
align |
table alignment (one of left, center or right) |
word_title |
alternative text for Word table (used as title of the table) |
word_description |
alternative text for Word table (used as description of the table) |
Other functions for table definition:
table_colwidths()
,
table_conditional_formatting()
,
table_layout()
,
table_stylenames()
,
table_width()
prop_table() to_wml(prop_table())
prop_table() to_wml(prop_table())
read and import a docx file as an R object representing the document. When no file is specified, it uses a default empty file.
Use then this object to add content to it and create Word files from R.
read_docx(path = NULL) ## S3 method for class 'rdocx' print(x, target = NULL, ...)
read_docx(path = NULL) ## S3 method for class 'rdocx' print(x, target = NULL, ...)
path |
path to the docx file to use as base document.
|
x |
an rdocx object |
target |
path to the docx file to write |
... |
unused |
an object of class rdocx
.
print(rdocx)
: write docx to a file. It returns the path of the result
file.
read_docx()
uses a Word file as the initial document.
This is the original Word document from which the document
layout, paragraph styles, or table styles come.
You will be able to add formatted text, change the paragraph style with the R api but also use the styles from the original document.
See body_add_*
functions to add content.
body_add_par, body_add_plot, body_add_table
library(officer) pinst <- plot_instr({ z <- c(rnorm(100), rnorm(50, mean = 5)) plot(density(z)) }) doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, "This is a table", style = "heading 2") doc_1 <- body_add_table(doc_1, value = mtcars, style = "table_template") doc_1 <- body_add_par(doc_1, "This is a plot", style = "heading 2") doc_1 <- body_add_plot(doc_1, pinst) docx_file_1 <- print(doc_1, target = tempfile(fileext = ".docx")) template <- system.file(package = "officer", "doc_examples", "landscape.docx") doc_2 <- read_docx(path = template) doc_2 <- body_add_par(doc_2, "This is a table", style = "heading 2") doc_2 <- body_add_table(doc_2, value = mtcars) doc_2 <- body_add_par(doc_2, "This is a plot", style = "heading 2") doc_2 <- body_add_plot(doc_2, pinst) docx_file_2 <- print(doc_2, target = tempfile(fileext = ".docx"))
library(officer) pinst <- plot_instr({ z <- c(rnorm(100), rnorm(50, mean = 5)) plot(density(z)) }) doc_1 <- read_docx() doc_1 <- body_add_par(doc_1, "This is a table", style = "heading 2") doc_1 <- body_add_table(doc_1, value = mtcars, style = "table_template") doc_1 <- body_add_par(doc_1, "This is a plot", style = "heading 2") doc_1 <- body_add_plot(doc_1, pinst) docx_file_1 <- print(doc_1, target = tempfile(fileext = ".docx")) template <- system.file(package = "officer", "doc_examples", "landscape.docx") doc_2 <- read_docx(path = template) doc_2 <- body_add_par(doc_2, "This is a table", style = "heading 2") doc_2 <- body_add_table(doc_2, value = mtcars) doc_2 <- body_add_par(doc_2, "This is a plot", style = "heading 2") doc_2 <- body_add_plot(doc_2, pinst) docx_file_2 <- print(doc_2, target = tempfile(fileext = ".docx"))
Read and import a pptx file as an R object representing the document.
The function is called read_pptx
because it allows you to initialize an
object of class rpptx
from an existing PowerPoint file. Content will be
added to the existing presentation. By default, an empty document is used.
read_pptx(path = NULL)
read_pptx(path = NULL)
path |
path to the pptx file to use as base document. |
read_pptx()
uses a PowerPoint file as the initial document. This is the original
PowerPoint document where all slide layouts, placeholders for shapes and
styles come from. Major points to be aware of are:
Slide layouts are relative to a master layout. A document can contain one or more master layouts; a master layout can contain one or more slide layouts.
A slide layout inherits design properties from its master layout but some properties can be overwritten.
Designs and formatting properties of layouts and shapes (placeholders in a layout) are defined within the initial document. There is no R function to modify these values - they must be defined in the initial document.
print.rpptx()
, add_slide()
, plot_layout_properties()
, ph_with()
read_pptx()
read_pptx()
Read and import an xlsx file as an R object representing the document. This function is experimental.
read_xlsx(path = NULL) ## S3 method for class 'rxlsx' length(x) ## S3 method for class 'rxlsx' print(x, target = NULL, ...)
read_xlsx(path = NULL) ## S3 method for class 'rxlsx' length(x) ## S3 method for class 'rxlsx' print(x, target = NULL, ...)
path |
path to the xlsx file to use as base document. |
x |
an rxlsx object |
target |
path to the xlsx file to write |
... |
unused |
read_xlsx() x <- read_xlsx() print(x, target = tempfile(fileext = ".xlsx"))
read_xlsx() x <- read_xlsx() print(x, target = tempfile(fileext = ".xlsx"))
Remove a slide from a pptx presentation.
remove_slide(x, index = NULL, rm_images = FALSE)
remove_slide(x, index = NULL, rm_images = FALSE)
x |
an rpptx object |
index |
slide index, default to current slide position. |
rm_images |
if TRUE (defaults to FALSE), images presented in the slide to remove are also removed from the file. |
cursor is set on the last slide.
read_pptx()
, ph_with()
, ph_remove()
Other functions slide manipulation:
add_slide()
,
move_slide()
,
on_slide()
,
set_notes()
my_pres <- read_pptx() my_pres <- add_slide(my_pres) my_pres <- remove_slide(my_pres)
my_pres <- read_pptx() my_pres <- add_slide(my_pres) my_pres <- remove_slide(my_pres)
This function add 'officer' objects into an RTF document. Values are added as new paragraphs. See section 'Methods (by class)' that list supported objects.
rtf_add(x, value, ...) ## S3 method for class 'block_section' rtf_add(x, value, ...) ## S3 method for class 'character' rtf_add(x, value, ...) ## S3 method for class 'factor' rtf_add(x, value, ...) ## S3 method for class 'double' rtf_add(x, value, formatter = formatC, ...) ## S3 method for class 'fpar' rtf_add(x, value, ...) ## S3 method for class 'block_list' rtf_add(x, value, ...) ## S3 method for class 'gg' rtf_add( x, value, width = 6, height = 5, res = 300, scale = 1, ppr = fp_par(text.align = "center"), ... ) ## S3 method for class 'plot_instr' rtf_add( x, value, width = 6, height = 5, res = 300, scale = 1, ppr = fp_par(text.align = "center"), ... )
rtf_add(x, value, ...) ## S3 method for class 'block_section' rtf_add(x, value, ...) ## S3 method for class 'character' rtf_add(x, value, ...) ## S3 method for class 'factor' rtf_add(x, value, ...) ## S3 method for class 'double' rtf_add(x, value, formatter = formatC, ...) ## S3 method for class 'fpar' rtf_add(x, value, ...) ## S3 method for class 'block_list' rtf_add(x, value, ...) ## S3 method for class 'gg' rtf_add( x, value, width = 6, height = 5, res = 300, scale = 1, ppr = fp_par(text.align = "center"), ... ) ## S3 method for class 'plot_instr' rtf_add( x, value, width = 6, height = 5, res = 300, scale = 1, ppr = fp_par(text.align = "center"), ... )
x |
rtf object, created by |
value |
object to add in the document. Supported objects are vectors, graphics, block of formatted paragraphs. Use package 'flextable' to add tables. |
... |
further arguments passed to or from other methods. When
adding a |
formatter |
function used to format the numerical values |
width |
height in inches |
height |
height in inches |
res |
resolution of the png image in ppi |
scale |
Multiplicative scaling factor, same as in ggsave |
ppr |
|
rtf_add(block_section)
: add a new section definition
rtf_add(character)
: add characters as new paragraphs
rtf_add(factor)
: add a factor vector as new paragraphs
rtf_add(double)
: add a double vector as new paragraphs
rtf_add(fpar)
: add an fpar()
rtf_add(block_list)
: add an block_list()
rtf_add(gg)
: add a ggplot2
rtf_add(plot_instr)
: add a plot_instr()
object
library(officer) def_text <- fp_text_lite(color = "#006699", bold = TRUE) center_par <- fp_par(text.align = "center", padding = 3) doc <- rtf_doc( normal_par = fp_par(line_spacing = 1.4, padding = 3) ) doc <- rtf_add( x = doc, value = fpar( ftext("how are you?", prop = def_text), fp_p = fp_par(text.align = "center") ) ) a_paragraph <- fpar( ftext("Here is a date: ", prop = def_text), run_word_field(field = "Date \\@ \"MMMM d yyyy\""), fp_p = center_par ) doc <- rtf_add( x = doc, value = block_list( a_paragraph, a_paragraph, a_paragraph ) ) if (require("ggplot2")) { gg <- gg_plot <- ggplot(data = iris) + geom_point(mapping = aes(Sepal.Length, Petal.Length)) doc <- rtf_add(doc, gg, width = 3, height = 4, ppr = center_par ) } anyplot <- plot_instr(code = { barplot(1:5, col = 2:6) }) doc <- rtf_add(doc, anyplot, width = 5, height = 4, ppr = center_par ) print(doc, target = tempfile(fileext = ".rtf"))
library(officer) def_text <- fp_text_lite(color = "#006699", bold = TRUE) center_par <- fp_par(text.align = "center", padding = 3) doc <- rtf_doc( normal_par = fp_par(line_spacing = 1.4, padding = 3) ) doc <- rtf_add( x = doc, value = fpar( ftext("how are you?", prop = def_text), fp_p = fp_par(text.align = "center") ) ) a_paragraph <- fpar( ftext("Here is a date: ", prop = def_text), run_word_field(field = "Date \\@ \"MMMM d yyyy\""), fp_p = center_par ) doc <- rtf_add( x = doc, value = block_list( a_paragraph, a_paragraph, a_paragraph ) ) if (require("ggplot2")) { gg <- gg_plot <- ggplot(data = iris) + geom_point(mapping = aes(Sepal.Length, Petal.Length)) doc <- rtf_add(doc, gg, width = 3, height = 4, ppr = center_par ) } anyplot <- plot_instr(code = { barplot(1:5, col = 2:6) }) doc <- rtf_add(doc, anyplot, width = 5, height = 4, ppr = center_par ) print(doc, target = tempfile(fileext = ".rtf"))
Creation of the object representing an
RTF document which can then receive contents with
the rtf_add()
function and be written to a file with
the print(x, target="doc.rtf")
function.
rtf_doc( def_sec = prop_section(), normal_par = fp_par(), normal_chunk = fp_text(font.family = "Arial", font.size = 11) )
rtf_doc( def_sec = prop_section(), normal_par = fp_par(), normal_chunk = fp_text(font.family = "Arial", font.size = 11) )
def_sec |
a block_section object used to defined default section. |
normal_par |
an object generated by |
normal_chunk |
an object generated by |
an object of class rtf
representing an
empty RTF document.
read_docx()
, print.rtf()
, rtf_add()
rtf_doc(normal_par = fp_par(padding = 3))
rtf_doc(normal_par = fp_par(padding = 3))
Create an autonumbered chunk, i.e. a string representation of a sequence, each item will be numbered. These runs can also be bookmarked and be used later for cross references.
run_autonum( seq_id = "table", pre_label = "Table ", post_label = ": ", bkm = NULL, bkm_all = FALSE, prop = NULL, start_at = NULL, tnd = 0, tns = "-" )
run_autonum( seq_id = "table", pre_label = "Table ", post_label = ": ", bkm = NULL, bkm_all = FALSE, prop = NULL, start_at = NULL, tnd = 0, tns = "-" )
seq_id |
sequence identifier |
pre_label , post_label
|
text to add before and after number |
bkm |
bookmark id to associate with autonumber run. If NULL, no bookmark is added. Value can only be made of alpha numeric characters, ':', -' and '_'. |
bkm_all |
if TRUE, the bookmark will be set on the whole string, if FALSE, the bookmark will be set on the number only. Default to FALSE. As an effect when a reference to this bookmark is used, the text can be like "Table 1" or "1" (pre_label is not included in the referenced text). |
prop |
formatting text properties returned by fp_text. |
start_at |
If not NULL, it must be a positive integer, it specifies the new number to use, at which number the auto numbering will restart. |
tnd |
title number depth, a positive integer (only applies if positive)
that specify the depth (or heading of level depth) to use for prefixing
the caption number with this last reference number. For example, setting
|
tns |
separator to use between title number and table number. Default is "-". |
You can use this function in conjunction with fpar to create paragraphs consisting of differently formatted text parts. You can also use this function as an r chunk in an R Markdown document made with package officedown.
Other run functions for reporting:
external_img()
,
ftext()
,
hyperlink_ftext()
,
run_bookmark()
,
run_columnbreak()
,
run_comment()
,
run_footnote()
,
run_footnoteref()
,
run_linebreak()
,
run_pagebreak()
,
run_reference()
,
run_tab()
,
run_word_field()
,
run_wordtext()
Other Word computed fields:
run_reference()
,
run_word_field()
run_autonum() run_autonum(seq_id = "fig", pre_label = "fig. ") run_autonum(seq_id = "tab", pre_label = "Table ", bkm = "anytable") run_autonum( seq_id = "tab", pre_label = "Table ", bkm = "anytable", tnd = 2, tns = " " )
run_autonum() run_autonum(seq_id = "fig", pre_label = "fig. ") run_autonum(seq_id = "tab", pre_label = "Table ", bkm = "anytable") run_autonum( seq_id = "tab", pre_label = "Table ", bkm = "anytable", tnd = 2, tns = " " )
Add a bookmark on a run object.
run_bookmark(bkm, run)
run_bookmark(bkm, run)
bkm |
bookmark id to associate with run. Value can only be made of alpha numeric characters, '-' and '_'. |
run |
a run object, made with a call to one of the "run functions for reporting". |
You can use this function in conjunction with fpar to create paragraphs consisting of differently formatted text parts. You can also use this function as an r chunk in an R Markdown document made with package officedown.
Other run functions for reporting:
external_img()
,
ftext()
,
hyperlink_ftext()
,
run_autonum()
,
run_columnbreak()
,
run_comment()
,
run_footnote()
,
run_footnoteref()
,
run_linebreak()
,
run_pagebreak()
,
run_reference()
,
run_tab()
,
run_word_field()
,
run_wordtext()
ft <- fp_text(font.size = 12, bold = TRUE) run_bookmark("par1", ftext("some text", ft))
ft <- fp_text(font.size = 12, bold = TRUE) run_bookmark("par1", ftext("some text", ft))
Create a representation of a column break.
run_columnbreak()
run_columnbreak()
You can use this function in conjunction with fpar to create paragraphs consisting of differently formatted text parts. You can also use this function as an r chunk in an R Markdown document made with package officedown.
Other run functions for reporting:
external_img()
,
ftext()
,
hyperlink_ftext()
,
run_autonum()
,
run_bookmark()
,
run_comment()
,
run_footnote()
,
run_footnoteref()
,
run_linebreak()
,
run_pagebreak()
,
run_reference()
,
run_tab()
,
run_word_field()
,
run_wordtext()
run_columnbreak()
run_columnbreak()
Add a comment on a run object.
run_comment( cmt, run = ftext(""), author = "", date = "", initials = "", prop = NULL )
run_comment( cmt, run = ftext(""), author = "", date = "", initials = "", prop = NULL )
cmt |
a set of blocks to be used as comment content returned by
function |
run |
a run object, made with a call to one of |
author |
comment author. |
date |
comment date |
initials |
comment initials |
prop |
formatting text properties returned by
|
Other run functions for reporting:
external_img()
,
ftext()
,
hyperlink_ftext()
,
run_autonum()
,
run_bookmark()
,
run_columnbreak()
,
run_footnote()
,
run_footnoteref()
,
run_linebreak()
,
run_pagebreak()
,
run_reference()
,
run_tab()
,
run_word_field()
,
run_wordtext()
fp_bold <- fp_text_lite(bold = TRUE) fp_red <- fp_text_lite(color = "red") bl <- block_list( fpar(ftext("Comment multiple words.", fp_bold)), fpar( ftext("Second line.", fp_red) ) ) comment1 <- run_comment( cmt = bl, run = ftext("with a comment"), author = "Author Me", date = Sys.Date(), initials = "AM" ) par1 <- fpar("A paragraph ", comment1) bl <- block_list( fpar(ftext("Comment a paragraph.")) ) comment2 <- run_comment( cmt = bl, run = ftext("A commented paragraph"), author = "Author You", date = Sys.Date(), initials = "AY" ) par2 <- fpar(comment2) doc <- read_docx() doc <- body_add_fpar(doc, value = par1, style = "Normal") doc <- body_add_fpar(doc, value = par2, style = "Normal") print(doc, target = tempfile(fileext = ".docx"))
fp_bold <- fp_text_lite(bold = TRUE) fp_red <- fp_text_lite(color = "red") bl <- block_list( fpar(ftext("Comment multiple words.", fp_bold)), fpar( ftext("Second line.", fp_red) ) ) comment1 <- run_comment( cmt = bl, run = ftext("with a comment"), author = "Author Me", date = Sys.Date(), initials = "AM" ) par1 <- fpar("A paragraph ", comment1) bl <- block_list( fpar(ftext("Comment a paragraph.")) ) comment2 <- run_comment( cmt = bl, run = ftext("A commented paragraph"), author = "Author You", date = Sys.Date(), initials = "AY" ) par2 <- fpar(comment2) doc <- read_docx() doc <- body_add_fpar(doc, value = par1, style = "Normal") doc <- body_add_fpar(doc, value = par2, style = "Normal") print(doc, target = tempfile(fileext = ".docx"))
Wraps a footnote in an object that can then be inserted
as a run/chunk with fpar()
or within an R Markdown document.
run_footnote(x, prop = NULL)
run_footnote(x, prop = NULL)
x |
a set of blocks to be used as footnote content returned by
function |
prop |
formatting text properties returned by
|
Other run functions for reporting:
external_img()
,
ftext()
,
hyperlink_ftext()
,
run_autonum()
,
run_bookmark()
,
run_columnbreak()
,
run_comment()
,
run_footnoteref()
,
run_linebreak()
,
run_pagebreak()
,
run_reference()
,
run_tab()
,
run_word_field()
,
run_wordtext()
library(officer) fp_bold <- fp_text_lite(bold = TRUE) fp_refnote <- fp_text_lite(vertical.align = "superscript") img.file <- file.path(R.home("doc"), "html", "logo.jpg") bl <- block_list( fpar(ftext("hello", fp_bold)), fpar( ftext("hello world", fp_bold), external_img(src = img.file, height = 1.06, width = 1.39) ) ) a_par <- fpar( "this paragraph contains a note ", run_footnote(x = bl, prop = fp_refnote), "." ) doc <- read_docx() doc <- body_add_fpar(doc, value = a_par, style = "Normal") print(doc, target = tempfile(fileext = ".docx"))
library(officer) fp_bold <- fp_text_lite(bold = TRUE) fp_refnote <- fp_text_lite(vertical.align = "superscript") img.file <- file.path(R.home("doc"), "html", "logo.jpg") bl <- block_list( fpar(ftext("hello", fp_bold)), fpar( ftext("hello world", fp_bold), external_img(src = img.file, height = 1.06, width = 1.39) ) ) a_par <- fpar( "this paragraph contains a note ", run_footnote(x = bl, prop = fp_refnote), "." ) doc <- read_docx() doc <- body_add_fpar(doc, value = a_par, style = "Normal") print(doc, target = tempfile(fileext = ".docx"))
Wraps a footnote reference in an object that can then be inserted
as a run/chunk with fpar()
or within an R Markdown document.
run_footnoteref(prop = NULL)
run_footnoteref(prop = NULL)
prop |
formatting text properties returned by
|
Other run functions for reporting:
external_img()
,
ftext()
,
hyperlink_ftext()
,
run_autonum()
,
run_bookmark()
,
run_columnbreak()
,
run_comment()
,
run_footnote()
,
run_linebreak()
,
run_pagebreak()
,
run_reference()
,
run_tab()
,
run_word_field()
,
run_wordtext()
run_footnoteref() to_wml(run_footnoteref())
run_footnoteref() to_wml(run_footnoteref())
Object representing a line break for a Word document. The result must be used within a call to fpar.
run_linebreak()
run_linebreak()
You can use this function in conjunction with fpar to create paragraphs consisting of differently formatted text parts. You can also use this function as an r chunk in an R Markdown document made with package officedown.
Other run functions for reporting:
external_img()
,
ftext()
,
hyperlink_ftext()
,
run_autonum()
,
run_bookmark()
,
run_columnbreak()
,
run_comment()
,
run_footnote()
,
run_footnoteref()
,
run_pagebreak()
,
run_reference()
,
run_tab()
,
run_word_field()
,
run_wordtext()
fp_t <- fp_text(font.size = 12, bold = TRUE) an_fpar <- fpar("let's add a line break", run_linebreak(), ftext("and blah blah!", fp_t)) x <- read_docx() x <- body_add(x, an_fpar) print(x, target = tempfile(fileext = ".docx"))
fp_t <- fp_text(font.size = 12, bold = TRUE) an_fpar <- fpar("let's add a line break", run_linebreak(), ftext("and blah blah!", fp_t)) x <- read_docx() x <- body_add(x, an_fpar) print(x, target = tempfile(fileext = ".docx"))
Object representing a page break for a Word document.
run_pagebreak()
run_pagebreak()
You can use this function in conjunction with fpar to create paragraphs consisting of differently formatted text parts. You can also use this function as an r chunk in an R Markdown document made with package officedown.
Other run functions for reporting:
external_img()
,
ftext()
,
hyperlink_ftext()
,
run_autonum()
,
run_bookmark()
,
run_columnbreak()
,
run_comment()
,
run_footnote()
,
run_footnoteref()
,
run_linebreak()
,
run_reference()
,
run_tab()
,
run_word_field()
,
run_wordtext()
fp_t <- fp_text(font.size = 12, bold = TRUE) an_fpar <- fpar("let's add a break page", run_pagebreak(), ftext("and blah blah!", fp_t)) x <- read_docx() x <- body_add(x, an_fpar) print(x, target = tempfile(fileext = ".docx"))
fp_t <- fp_text(font.size = 12, bold = TRUE) an_fpar <- fpar("let's add a break page", run_pagebreak(), ftext("and blah blah!", fp_t)) x <- read_docx() x <- body_add(x, an_fpar) print(x, target = tempfile(fileext = ".docx"))
Create a representation of a reference
run_reference(id, prop = NULL)
run_reference(id, prop = NULL)
id |
reference id, a string |
prop |
formatting text properties returned by fp_text. |
You can use this function in conjunction with fpar to create paragraphs consisting of differently formatted text parts. You can also use this function as an r chunk in an R Markdown document made with package officedown.
Other run functions for reporting:
external_img()
,
ftext()
,
hyperlink_ftext()
,
run_autonum()
,
run_bookmark()
,
run_columnbreak()
,
run_comment()
,
run_footnote()
,
run_footnoteref()
,
run_linebreak()
,
run_pagebreak()
,
run_tab()
,
run_word_field()
,
run_wordtext()
Other Word computed fields:
run_autonum()
,
run_word_field()
run_reference("a_ref")
run_reference("a_ref")
Object representing a tab in a Word document. The result must be used within a call to fpar. It will only have effects in Word output.
Tabulation marks settings can be defined with fp_tabs()
in
paragraph settings defined with fp_par()
.
run_tab()
run_tab()
You can use this function in conjunction with fpar to create paragraphs consisting of differently formatted text parts. You can also use this function as an r chunk in an R Markdown document made with package officedown.
Other run functions for reporting:
external_img()
,
ftext()
,
hyperlink_ftext()
,
run_autonum()
,
run_bookmark()
,
run_columnbreak()
,
run_comment()
,
run_footnote()
,
run_footnoteref()
,
run_linebreak()
,
run_pagebreak()
,
run_reference()
,
run_word_field()
,
run_wordtext()
z <- fp_tabs( fp_tab(pos = 0.5, style = "decimal"), fp_tab(pos = 1.5, style = "decimal") ) par1 <- fpar( run_tab(), ftext("88."), run_tab(), ftext("987.45"), fp_p = fp_par( tabs = z ) ) par2 <- fpar( run_tab(), ftext("8."), run_tab(), ftext("670987.45"), fp_p = fp_par( tabs = z ) ) x <- read_docx() x <- body_add(x, par1) x <- body_add(x, par2) print(x, target = tempfile(fileext = ".docx"))
z <- fp_tabs( fp_tab(pos = 0.5, style = "decimal"), fp_tab(pos = 1.5, style = "decimal") ) par1 <- fpar( run_tab(), ftext("88."), run_tab(), ftext("987.45"), fp_p = fp_par( tabs = z ) ) par2 <- fpar( run_tab(), ftext("8."), run_tab(), ftext("670987.45"), fp_p = fp_par( tabs = z ) ) x <- read_docx() x <- body_add(x, par1) x <- body_add(x, par2) print(x, target = tempfile(fileext = ".docx"))
Create a 'Word' computed field.
run_word_field(field, prop = NULL, seqfield = NULL) run_seqfield(field, prop = NULL, seqfield = NULL)
run_word_field(field, prop = NULL, seqfield = NULL) run_seqfield(field, prop = NULL, seqfield = NULL)
field |
Value for a "Word Computed Field" as a string. |
prop |
formatting text properties returned by fp_text. |
seqfield |
deprecated in favor of |
You can use this function in conjunction with fpar to create paragraphs consisting of differently formatted text parts. You can also use this function as an r chunk in an R Markdown document made with package officedown.
In the previous version, this function was called run_seqfield
but the name was wrong and should have been run_word_field
.
Other run functions for reporting:
external_img()
,
ftext()
,
hyperlink_ftext()
,
run_autonum()
,
run_bookmark()
,
run_columnbreak()
,
run_comment()
,
run_footnote()
,
run_footnoteref()
,
run_linebreak()
,
run_pagebreak()
,
run_reference()
,
run_tab()
,
run_wordtext()
Other Word computed fields:
run_autonum()
,
run_reference()
run_word_field(field = "PAGE \\* MERGEFORMAT") run_word_field(field = "Date \\@ \"MMMM d yyyy\"")
run_word_field(field = "PAGE \\* MERGEFORMAT") run_word_field(field = "Date \\@ \"MMMM d yyyy\"")
Format a chunk of text associated with a 'Word' character style. The style is defined with its unique identifer.
run_wordtext(text, style_id = NULL)
run_wordtext(text, style_id = NULL)
text |
text value, a single character value |
style_id |
'Word' unique style identifier associated with the style to use. |
Other run functions for reporting:
external_img()
,
ftext()
,
hyperlink_ftext()
,
run_autonum()
,
run_bookmark()
,
run_columnbreak()
,
run_comment()
,
run_footnote()
,
run_footnoteref()
,
run_linebreak()
,
run_pagebreak()
,
run_reference()
,
run_tab()
,
run_word_field()
run1 <- run_wordtext("hello", "DefaultParagraphFont") paragraph <- fpar(run1) x <- read_docx() x <- body_add_fpar(x, paragraph) print(x, target = tempfile(fileext = ".docx"))
run1 <- run_wordtext("hello", "DefaultParagraphFont") paragraph <- fpar(run1) x <- read_docx() x <- body_add_fpar(x, paragraph) print(x, target = tempfile(fileext = ".docx"))
The function creates a representation of the columns of a section.
section_columns(widths = c(2.5, 2.5), space = 0.25, sep = FALSE)
section_columns(widths = c(2.5, 2.5), space = 0.25, sep = FALSE)
widths |
columns widths in inches. If 3 values, 3 columns will be produced. |
space |
space in inches between columns. |
sep |
if TRUE a line is separating columns. |
Other functions for section definition:
page_mar()
,
page_size()
,
prop_section()
section_columns()
section_columns()
This function lets recycling a object
made by run_autonum()
by changing the bookmark value. This
is useful to avoid calling run_autonum()
several times
because of many tables.
set_autonum_bookmark(x, bkm = NULL)
set_autonum_bookmark(x, bkm = NULL)
x |
an object of class |
bkm |
bookmark id to associate with autonumber run. Value can only be made of alpha numeric characters, ':', -' and '_'. |
z <- run_autonum( seq_id = "tab", pre_label = "Table ", bkm = "anytable" ) set_autonum_bookmark(z, bkm = "anothertable")
z <- run_autonum( seq_id = "tab", pre_label = "Table ", bkm = "anytable" ) set_autonum_bookmark(z, bkm = "anothertable")
set Word or PowerPoint document properties. These are not visible in the document but are available as metadata of the document.
Any character property can be added as a document property. It provides an easy way to insert arbitrary fields. Given the challenges that can be encountered with find-and-replace in word with officer, the use of document fields and quick text fields provides a much more robust approach to automatic document generation from R.
set_doc_properties( x, title = NULL, subject = NULL, creator = NULL, description = NULL, created = NULL, ..., values = NULL )
set_doc_properties( x, title = NULL, subject = NULL, creator = NULL, description = NULL, created = NULL, ..., values = NULL )
x |
an rdocx or rpptx object |
title , subject , creator , description
|
text fields |
created |
a date object |
... |
named arguments (names are field names), each element is a single character value specifying value associated with the corresponding field name. |
values |
a named list (names are field names), each element is a single
character value specifying value associated with the corresponding field name.
If |
The "last modified" and "last modified by" fields will be automatically be updated when the file is written.
Other functions for Word document informations:
doc_properties()
,
docx_bookmarks()
,
docx_dim()
,
length.rdocx()
,
styles_info()
x <- read_docx() x <- set_doc_properties(x, title = "title", subject = "document subject", creator = "Me me me", description = "this document is empty", created = Sys.time(), yoyo = "yok yok", glop = "pas glop") x <- doc_properties(x)
x <- read_docx() x <- set_doc_properties(x, title = "title", subject = "document subject", creator = "Me me me", description = "this document is empty", created = Sys.time(), yoyo = "yok yok", glop = "pas glop") x <- doc_properties(x)
Set speaker notes for the current slide in a pptx presentation.
set_notes(x, value, location, ...) ## S3 method for class 'character' set_notes(x, value, location, ...) ## S3 method for class 'block_list' set_notes(x, value, location, ...)
set_notes(x, value, location, ...) ## S3 method for class 'character' set_notes(x, value, location, ...) ## S3 method for class 'block_list' set_notes(x, value, location, ...)
x |
an rpptx object |
value |
text to be added to notes |
location |
a placeholder location object.
It will be used to specify the location of the new shape. This location
can be defined with a call to one of the notes_ph functions. See
section |
... |
further arguments passed to or from other methods. |
set_notes(character)
: add a character vector to a place holder in the notes on the
current slide, values will be added as paragraphs.
set_notes(block_list)
: add a block_list()
to a place holder in the notes on the
current slide.
print.rpptx()
, read_pptx()
, add_slide()
, notes_location_label()
, notes_location_type()
Other functions slide manipulation:
add_slide()
,
move_slide()
,
on_slide()
,
remove_slide()
# this name will be used to print the file # change it to "youfile.pptx" to write the pptx # file in your working directory. fileout <- tempfile(fileext = ".pptx") fpt_blue_bold <- fp_text_lite(color = "#006699", bold = TRUE) doc <- read_pptx() # add a slide with some text ---- doc <- add_slide(doc, layout = "Title and Content", master = "Office Theme") doc <- ph_with(x = doc, value = "Slide Title 1", location = ph_location_type(type = "title") ) # set speaker notes for the slide ---- doc <- set_notes(doc, value = "This text will only be visible for the speaker.", location = notes_location_type("body")) # add a slide with some text ---- doc <- add_slide(doc, layout = "Title and Content", master = "Office Theme") doc <- ph_with(x = doc, value = "Slide Title 2", location = ph_location_type(type = "title") ) bl <- block_list( fpar(ftext("hello world", fpt_blue_bold)), fpar(ftext("Turlututu chapeau pointu", fpt_blue_bold)) ) doc <- set_notes(doc, value = bl, location = notes_location_type("body")) print(doc, target = fileout)
# this name will be used to print the file # change it to "youfile.pptx" to write the pptx # file in your working directory. fileout <- tempfile(fileext = ".pptx") fpt_blue_bold <- fp_text_lite(color = "#006699", bold = TRUE) doc <- read_pptx() # add a slide with some text ---- doc <- add_slide(doc, layout = "Title and Content", master = "Office Theme") doc <- ph_with(x = doc, value = "Slide Title 1", location = ph_location_type(type = "title") ) # set speaker notes for the slide ---- doc <- set_notes(doc, value = "This text will only be visible for the speaker.", location = notes_location_type("body")) # add a slide with some text ---- doc <- add_slide(doc, layout = "Title and Content", master = "Office Theme") doc <- ph_with(x = doc, value = "Slide Title 2", location = ph_location_type(type = "title") ) bl <- block_list( fpar(ftext("hello world", fpt_blue_bold)), fpar(ftext("Turlututu chapeau pointu", fpt_blue_bold)) ) doc <- set_notes(doc, value = bl, location = notes_location_type("body")) print(doc, target = fileout)
Set a particular sheet selected when workbook will be edited.
sheet_select(x, sheet)
sheet_select(x, sheet)
x |
rxlsx object |
sheet |
sheet name |
my_ws <- read_xlsx() my_pres <- add_sheet(my_ws, label = "new sheet") my_pres <- sheet_select(my_ws, sheet = "new sheet") print(my_ws, target = tempfile(fileext = ".xlsx") )
my_ws <- read_xlsx() my_pres <- add_sheet(my_ws, label = "new sheet") my_pres <- sheet_select(my_ws, sheet = "new sheet") print(my_ws, target = tempfile(fileext = ".xlsx") )
Shortcuts for fp_text
, fp_par
,
fp_cell
and fp_border
.
shortcuts
shortcuts
shortcuts$fp_bold() shortcuts$fp_italic() shortcuts$b_null()
shortcuts$fp_bold() shortcuts$fp_italic() shortcuts$b_null()
Get the width and height of slides in inches as a named vector.
slide_size(x)
slide_size(x)
x |
an rpptx object |
Other functions for reading presentation information:
annotate_base()
,
color_scheme()
,
doc_properties()
,
layout_properties()
,
layout_summary()
,
length.rpptx()
,
plot_layout_properties()
,
slide_summary()
my_pres <- read_pptx() my_pres <- add_slide(my_pres, layout = "Two Content", master = "Office Theme") slide_size(my_pres)
my_pres <- read_pptx() my_pres <- add_slide(my_pres, layout = "Two Content", master = "Office Theme") slide_size(my_pres)
Get content and positions of current slide into a data.frame. Data for any tables, images, or paragraphs are imported into the resulting data.frame.
slide_summary(x, index = NULL)
slide_summary(x, index = NULL)
x |
an rpptx object |
index |
slide index |
The column id
of the result is not to be used by users.
This is a technical string id whose value will be used by office
when the document will be rendered. This is not related to argument
index
required by functions ph_with
.
Other functions for reading presentation information:
annotate_base()
,
color_scheme()
,
doc_properties()
,
layout_properties()
,
layout_summary()
,
length.rpptx()
,
plot_layout_properties()
,
slide_size()
my_pres <- read_pptx() my_pres <- add_slide(my_pres) my_pres <- ph_with(my_pres, format(Sys.Date()), location = ph_location_type(type="dt")) my_pres <- add_slide(my_pres) my_pres <- ph_with(my_pres, iris[1:2,], location = ph_location_type(type="body")) slide_summary(my_pres) slide_summary(my_pres, index = 1)
my_pres <- read_pptx() my_pres <- add_slide(my_pres) my_pres <- ph_with(my_pres, format(Sys.Date()), location = ph_location_type(type="dt")) my_pres <- add_slide(my_pres) my_pres <- ph_with(my_pres, iris[1:2,], location = ph_location_type(type="body")) slide_summary(my_pres) slide_summary(my_pres, index = 1)
Create a sp_line
object that describes
line properties.
sp_line( color = "transparent", lwd = 1, lty = "solid", linecmpd = "sng", lineend = "rnd", linejoin = "round", headend = sp_lineend(type = "none"), tailend = sp_lineend(type = "none") ) ## S3 method for class 'sp_line' print(x, ...) ## S3 method for class 'sp_line' update( object, color, lwd, lty, linecmpd, lineend, linejoin, headend, tailend, ... )
sp_line( color = "transparent", lwd = 1, lty = "solid", linecmpd = "sng", lineend = "rnd", linejoin = "round", headend = sp_lineend(type = "none"), tailend = sp_lineend(type = "none") ) ## S3 method for class 'sp_line' print(x, ...) ## S3 method for class 'sp_line' update( object, color, lwd, lty, linecmpd, lineend, linejoin, headend, tailend, ... )
color |
line color - a single character value specifying a valid color (e.g. "#000000" or "black"). |
lwd |
line width (in point) - 0 or positive integer value. |
lty |
single character value specifying the line type.
Expected value is one of the following : default |
linecmpd |
single character value specifying the compound line type.
Expected value is one of the following : default |
lineend |
single character value specifying the line end style
Expected value is one of the following : default |
linejoin |
single character value specifying the line join style
Expected value is one of the following : default |
headend |
a |
tailend |
a |
x , object
|
|
... |
further arguments - not used |
a sp_line
object
Other functions for defining shape properties:
sp_lineend()
sp_line() sp_line(color = "red", lwd = 2) sp_line(lty = "dot", linecmpd = "dbl") print( sp_line (color="red", lwd = 2) ) obj <- sp_line (color="red", lwd = 2) update( obj, linecmpd = "dbl" )
sp_line() sp_line(color = "red", lwd = 2) sp_line(lty = "dot", linecmpd = "dbl") print( sp_line (color="red", lwd = 2) ) obj <- sp_line (color="red", lwd = 2) update( obj, linecmpd = "dbl" )
Create a sp_lineend
object that describes
line end properties.
sp_lineend(type = "none", width = "med", length = "med") ## S3 method for class 'sp_lineend' print(x, ...) ## S3 method for class 'sp_lineend' update(object, type, width, length, ...)
sp_lineend(type = "none", width = "med", length = "med") ## S3 method for class 'sp_lineend' print(x, ...) ## S3 method for class 'sp_lineend' update(object, type, width, length, ...)
type |
single character value specifying the line end type.
Expected value is one of the following : default |
width |
single character value specifying the line end width
Expected value is one of the following : default |
length |
single character value specifying the line end length
Expected value is one of the following : default |
x , object
|
|
... |
further arguments - not used |
a sp_lineend
object
Other functions for defining shape properties:
sp_line()
sp_lineend() sp_lineend(type = "triangle") sp_lineend(type = "arrow", width = "lg", length = "lg") print( sp_lineend (type="triangle", width = "lg") ) obj <- sp_lineend (type="triangle", width = "lg") update( obj, type = "arrow" )
sp_lineend() sp_lineend(type = "triangle") sp_lineend(type = "arrow", width = "lg", length = "lg") print( sp_lineend (type="triangle", width = "lg") ) obj <- sp_lineend (type="triangle", width = "lg") update( obj, type = "arrow" )
read Word styles and get results in a data.frame.
styles_info( x, type = c("paragraph", "character", "table", "numbering"), is_default = c(TRUE, FALSE) )
styles_info( x, type = c("paragraph", "character", "table", "numbering"), is_default = c(TRUE, FALSE) )
x |
an rdocx object |
type , is_default
|
subsets for types (i.e. paragraph) and
default style (when |
Other functions for Word document informations:
doc_properties()
,
docx_bookmarks()
,
docx_dim()
,
length.rdocx()
,
set_doc_properties()
x <- read_docx() styles_info(x) styles_info(x, type = "paragraph", is_default = TRUE)
x <- read_docx() styles_info(x) styles_info(x, type = "paragraph", is_default = TRUE)
The function defines the size of each column of a table.
table_colwidths(widths = NULL)
table_colwidths(widths = NULL)
widths |
Column widths expressed in inches. |
Other functions for table definition:
prop_table()
,
table_conditional_formatting()
,
table_layout()
,
table_stylenames()
,
table_width()
Tables can be conditionally formatted based on few properties as whether the content is in the first row, last row, first column, or last column, or whether the rows or columns are to be banded.
table_conditional_formatting( first_row = TRUE, first_column = FALSE, last_row = FALSE, last_column = FALSE, no_hband = FALSE, no_vband = TRUE )
table_conditional_formatting( first_row = TRUE, first_column = FALSE, last_row = FALSE, last_column = FALSE, no_hband = FALSE, no_vband = TRUE )
first_row , last_row
|
apply or remove formatting from the first or last row in the table. |
first_column , last_column
|
apply or remove formatting from the first or last column in the table. |
no_hband , no_vband
|
don't display odd and even rows or columns with alternating shading for ease of reading. |
You must define a format for first_row, first_column and other properties if you need to use them. The format is defined in a docx template.
Other functions for table definition:
prop_table()
,
table_colwidths()
,
table_layout()
,
table_stylenames()
,
table_width()
table_conditional_formatting(first_row = TRUE, first_column = TRUE)
table_conditional_formatting(first_row = TRUE, first_column = TRUE)
When a table is displayed in a document, it can either be displayed using a fixed width or autofit layout algorithm:
fixed: uses fixed widths for columns. The width of the table is not changed regardless of the contents of the cells.
autofit: uses the contents of each cell and the table width to determine the final column widths.
table_layout(type = "autofit")
table_layout(type = "autofit")
type |
'autofit' or 'fixed' algorithm. Default to 'autofit'. |
Other functions for table definition:
prop_table()
,
table_colwidths()
,
table_conditional_formatting()
,
table_stylenames()
,
table_width()
The function defines the paragraph styles for columns.
table_stylenames(stylenames = list())
table_stylenames(stylenames = list())
stylenames |
a named character vector, names are column names, values are paragraph styles associated with each column. If a column is not specified, default value 'Normal' is used. Another form is as a named list, the list names are the styles and the contents are column names to be formatted with the corresponding style. |
Other functions for table definition:
prop_table()
,
table_colwidths()
,
table_conditional_formatting()
,
table_layout()
,
table_width()
library(officer) stylenames <- c( vs = "centered", am = "centered", gear = "centered", carb = "centered" ) doc_1 <- read_docx() doc_1 <- body_add_table(doc_1, value = mtcars, style = "table_template", stylenames = table_stylenames(stylenames = stylenames) ) print(doc_1, target = tempfile(fileext = ".docx")) stylenames <- list( "centered" = c("vs", "am", "gear", "carb") ) doc_2 <- read_docx() doc_2 <- body_add_table(doc_2, value = mtcars, style = "table_template", stylenames = table_stylenames(stylenames = stylenames) ) print(doc_2, target = tempfile(fileext = ".docx"))
library(officer) stylenames <- c( vs = "centered", am = "centered", gear = "centered", carb = "centered" ) doc_1 <- read_docx() doc_1 <- body_add_table(doc_1, value = mtcars, style = "table_template", stylenames = table_stylenames(stylenames = stylenames) ) print(doc_1, target = tempfile(fileext = ".docx")) stylenames <- list( "centered" = c("vs", "am", "gear", "carb") ) doc_2 <- read_docx() doc_2 <- body_add_table(doc_2, value = mtcars, style = "table_template", stylenames = table_stylenames(stylenames = stylenames) ) print(doc_2, target = tempfile(fileext = ".docx"))
Define the preferred width for a table.
table_width(width = 1, unit = "pct")
table_width(width = 1, unit = "pct")
width |
value of the preferred width of the table. |
unit |
unit of the width. Possible values are 'in' (inches) and 'pct' (percent) |
All widths in a table are considered preferred because widths of columns can conflict and the table layout rules can require a preference to be overridden.
Other functions for table definition:
prop_table()
,
table_colwidths()
,
table_conditional_formatting()
,
table_layout()
,
table_stylenames()
unordered list of text for PowerPoint presentations. Each text is associated with a hierarchy level.
unordered_list(str_list = character(0), level_list = integer(0), style = NULL)
unordered_list(str_list = character(0), level_list = integer(0), style = NULL)
str_list |
list of strings to be included in the object |
level_list |
list of levels for hierarchy structure. Use 0 for 'no bullet', 1 for level 1, 2 for level 2 and so on. |
style |
text style, a |
Other block functions for reporting:
block_caption()
,
block_list()
,
block_pour_docx()
,
block_section()
,
block_table()
,
block_toc()
,
fpar()
,
plot_instr()
unordered_list( level_list = c(1, 2, 2, 3, 3, 1), str_list = c("Level1", "Level2", "Level2", "Level3", "Level3", "Level1"), style = fp_text(color = "red", font.size = 0) ) unordered_list( level_list = c(1, 2, 1), str_list = c("Level1", "Level2", "Level1"), style = list( fp_text(color = "red", font.size = 0), fp_text(color = "pink", font.size = 0), fp_text(color = "orange", font.size = 0) ))
unordered_list( level_list = c(1, 2, 2, 3, 3, 1), str_list = c("Level1", "Level2", "Level2", "Level3", "Level3", "Level1"), style = fp_text(color = "red", font.size = 0) ) unordered_list( level_list = c(1, 2, 1), str_list = c("Level1", "Level2", "Level1"), style = list( fp_text(color = "red", font.size = 0), fp_text(color = "pink", font.size = 0), fp_text(color = "orange", font.size = 0) ))